summaryrefslogtreecommitdiff
path: root/compiler/cmm
diff options
context:
space:
mode:
authorMax Bolingbroke <batterseapower@hotmail.com>2008-07-31 01:23:36 +0000
committerMax Bolingbroke <batterseapower@hotmail.com>2008-07-31 01:23:36 +0000
commita17889597792b1f2db29bdb92f4d1ee3a677d258 (patch)
tree3a1c311068406ee44822e4adb9ca56472dd0d0c0 /compiler/cmm
parentb025092d120eb8799ba0408cf96fb7cacb55db76 (diff)
downloadhaskell-a17889597792b1f2db29bdb92f4d1ee3a677d258.tar.gz
Document MachOp
Diffstat (limited to 'compiler/cmm')
-rw-r--r--compiler/cmm/MachOp.hs10
1 files changed, 5 insertions, 5 deletions
diff --git a/compiler/cmm/MachOp.hs b/compiler/cmm/MachOp.hs
index f2aadcf897..422ed5eac0 100644
--- a/compiler/cmm/MachOp.hs
+++ b/compiler/cmm/MachOp.hs
@@ -480,10 +480,10 @@ cLongRep = I64
-- isCommutableMachOp
{- |
-Returns 'True' if the MachOp has commutable arguments. This is used
+Returns @True@ if the MachOp has commutable arguments. This is used
in the platform-independent Cmm optimisations.
-If in doubt, return 'False'. This generates worse code on the
+If in doubt, return @False@. This generates worse code on the
native routes, but is otherwise harmless.
-}
isCommutableMachOp :: MachOp -> Bool
@@ -504,10 +504,10 @@ isCommutableMachOp mop =
-- isAssociativeMachOp
{- |
-Returns 'True' if the MachOp is associative (i.e. @(x+y)+z == x+(y+z)@)
+Returns @True@ if the MachOp is associative (i.e. @(x+y)+z == x+(y+z)@)
This is used in the platform-independent Cmm optimisations.
-If in doubt, return 'False'. This generates worse code on the
+If in doubt, return @False@. This generates worse code on the
native routes, but is otherwise harmless.
-}
isAssociativeMachOp :: MachOp -> Bool
@@ -524,7 +524,7 @@ isAssociativeMachOp mop =
-- isComparisonMachOp
{- |
-Returns 'True' if the MachOp is a comparison.
+Returns @True@ if the MachOp is a comparison.
If in doubt, return False. This generates worse code on the
native routes, but is otherwise harmless.