[add] Parser Asm haddock documentation

lib/Ast/Parser/Asm.hs

@@ -6,6 +6,17 @@ import qualified Data.Maybe as DM
 import qualified Text.Megaparsec as M
 import qualified Text.Megaparsec.Char as MC
 
+-- | Parses an inline assembly expression.
+-- Takes a `PU.Parser AT.Expr` for expressions and a `PU.Parser AT.Type` for types.
+-- Returns an `AT.AsmExpr` containing:
+--   * The assembly code
+--   * The assembly constraints
+--   * A list of expression arguments
+--   * A list of parameter types
+--   * A return type
+--   * Side-effect flags
+--   * Stack alignment flag
+--   * An assembly dialect
 parseAsm :: PU.Parser AT.Expr -> PU.Parser AT.Type -> PU.Parser AT.AsmExpr
 parseAsm ap tp = M.between (PU.symbol "{") (PU.symbol "}") $ do
   code <- PU.symbol "code ->" *> PU.lexeme anyString
@@ -18,6 +29,10 @@ parseAsm ap tp = M.between (PU.symbol "{") (PU.symbol "}") $ do
   dialect <- PU.symbol "dialect ->" *> parseAsmDialect
   return $ AT.AsmExpr code constraints args parameters returnType sideEffects alignStack dialect
 
+-- | Parses an assembly constraint string, which may include
+-- an optional output constraint and zero or more input constraints.
+-- Returns an `AT.AsmConstraint` containing an output constraint (if present)
+-- and a list of input constraints.
 parseAsmConstraint :: PU.Parser AT.AsmConstraint
 parseAsmConstraint = M.between (MC.char '"') (MC.char '"') $ do
   output <- M.optional parseConstraintOutput
@@ -26,14 +41,23 @@ parseAsmConstraint = M.between (MC.char '"') (MC.char '"') $ do
   where
     sep = MC.string ","
 
+-- | Parses a single assembly input constraint (`"r"` or `"m"`).
+-- Returns the parsed `String` representing the constraint.
 parseConstraintInput :: PU.Parser String
 parseConstraintInput = M.choice [MC.string "r", MC.string "m"]
 
+-- | Parses a single assembly output constraint, which is prefixed by `'='`
+-- and then expects either `"r"` or `"m"`.
+-- Returns the parsed `String` representing the constraint.
 parseConstraintOutput :: PU.Parser String
 parseConstraintOutput = MC.char '=' *> M.choice [MC.string "r", MC.string "m"]
 
+-- | Parses the assembly dialect, which can be either `Intel` or `ATT`.
+-- Returns an `AT.AsmDialect`.
 parseAsmDialect :: PU.Parser AT.AsmDialect
 parseAsmDialect = M.choice [AT.Intel <$ PU.symbol "Intel", AT.ATT <$ PU.symbol "ATT"]
 
+-- | Parses a string enclosed in double quotes (`"..."`).
+-- Returns the parsed `String`.
 anyString :: PU.Parser String
 anyString = M.between (MC.char '\"') (MC.char '\"') $ M.many PU.parseStringChar