Haddock fixes

This commit is contained in:
Your Name 2024-11-12 14:13:51 -05:00
parent 3ff61dc8cc
commit d4f6105e90
2 changed files with 10 additions and 10 deletions

View File

@ -52,12 +52,11 @@ instance X.Exception DiscoverException
-- | Convert machine addresses into What4 positions. -- | Convert machine addresses into What4 positions.
-- --
-- When possible, we map to the structured 'WPL.BinaryPos' type. However, some -- When possible, we map to the structured 'WPL.BinaryPos' type. However,
-- 'MM.MemSegmentOff' cannot be mapped to an absolute position (e.g., some -- some 'MM.MemSegmentOff' values cannot be mapped to an absolute position
-- addresses from shared libraries are in non-trivial segments). In those cases, -- (e.g., some addresses from shared libraries are in non-trivial segments).
-- we map to the unstructured 'WPL.Others' with a sufficiently descriptive string. -- In those cases, we map to the unstructured 'WPL.Others' with a sufficiently
-- -- descriptive string.
-- TODO: import from `Testing`
posFn :: (MM.MemWidth w) => Text.Text -> MM.MemSegmentOff w -> WPL.Position posFn :: (MM.MemWidth w) => Text.Text -> MM.MemSegmentOff w -> WPL.Position
posFn binaryName segOff = posFn binaryName segOff =
case MM.segoffAsAbsoluteAddr segOff of case MM.segoffAsAbsoluteAddr segOff of

View File

@ -113,10 +113,11 @@ instance X.Exception TestingException
-- | Convert machine addresses into Crucible positions. -- | Convert machine addresses into Crucible positions.
-- --
-- When possible, we map to the structured 'WPL.BinaryPos' type. However, some -- When possible, we map to the structured 'WPL.BinaryPos' type. However,
-- 'MM.MemSegmentOff' cannot be mapped to an absolute position (e.g., some -- some 'MM.MemSegmentOff' values cannot be mapped to an absolute position
-- addresses from shared libraries are in non-trivial segments). In those cases, -- (e.g., some addresses from shared libraries are in non-trivial segments).
-- we map to the unstructured 'WPL.Others' with a sufficiently descriptive string. -- In those cases, we map to the unstructured 'WPL.Others' with a sufficiently
-- descriptive string.
posFn :: (MM.MemWidth w) => FilePath -> MM.MemSegmentOff w -> WPL.Position posFn :: (MM.MemWidth w) => FilePath -> MM.MemSegmentOff w -> WPL.Position
posFn binaryName segOff = posFn binaryName segOff =
case MM.segoffAsAbsoluteAddr segOff of case MM.segoffAsAbsoluteAddr segOff of