Merge pull request #944 from GaloisInc/uc-crux-haddock

Haddock fails on commenting function args for record elements.
GaloisInc · Jan 4, 2022 · c6c9298 · c6c9298
2 parents 9305587 + 164241c
commit c6c9298
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/uc-crux-llvm/src/UCCrux/LLVM/Run/Check.hs b/uc-crux-llvm/src/UCCrux/LLVM/Run/Check.hs
@@ -119,15 +119,15 @@ newtype CheckResult m arch (argTypes :: Ctx (FullType m)) =
         (forall sym.
          IsSymInterface sym =>
          sym ->
-         -- | Pre-simulation memory
          PreSimulationMem sym ->
-         -- | Arguments passed to the entry point
          Assignment (Shape m (SymValue sym arch)) argTypes ->
          Crux.CruxSimulationResult ->
          Sim.UCCruxSimulationResult m arch argTypes ->
          [SomeCheckedCalls m sym arch] ->
          r) ->
         r
+    -- ^ The 'PreSimulationMem sym' parameter is the Pre-simulation memory.
+    -- The 'Assignment' specifies the Arguments passed to the entry point.
     }
 
 data SomeCheckResult m arch =

diff --git a/uc-crux-llvm/src/UCCrux/LLVM/Run/Simulate.hs b/uc-crux-llvm/src/UCCrux/LLVM/Run/Simulate.hs
@@ -163,11 +163,11 @@ data UCCruxSimulationResult m arch (argTypes :: Ctx (FullType m)) = UCCruxSimula
 data SimulatorHooks sym m arch (argTypes :: Ctx (FullType m)) r =
   SimulatorHooks
     { createOverrideHooks :: [SymCreateOverrideFn sym arch]
+    -- | The 'PreSimulationMem sym' parameter is the Pre-simulation memory.
+    -- The 'Assignment' specifies the Arguments passed to the entry point.
     , resultHook ::
         sym ->
-        -- | Pre-simulation memory
         PreSimulationMem sym ->
-        -- | Arguments passed to the entry point
         Assignment (Shape m (SymValue sym arch)) argTypes ->
         Crux.CruxSimulationResult ->
         UCCruxSimulationResult m arch argTypes ->