From 19de64745c54ee8a79cae02ce290113a1f5a00a8 Mon Sep 17 00:00:00 2001 From: Rose Date: Wed, 15 May 2019 16:54:48 +0100 Subject: [PATCH] more docs lol --- src/Lazyboy/Control.hs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/Lazyboy/Control.hs b/src/Lazyboy/Control.hs index 71f760a..edcf503 100644 --- a/src/Lazyboy/Control.hs +++ b/src/Lazyboy/Control.hs @@ -24,9 +24,11 @@ getLabel = do modify (+ 1) return label +-- | Get a local label. The name is guaranteed to be unique. getLocalLabel :: Lazyboy Label getLocalLabel = Local <$> getLabel +-- | Get a global label. The name is guaranteed to be unique. getGlobalLabel :: Lazyboy Label getGlobalLabel = Global <$> getLabel @@ -44,7 +46,8 @@ withLocalLabel block = do tell [LABEL label] block label --- | Embed a file and return a (global) label for it. +-- | Embed a file and return a global label for it. +-- A jump over the block of data is added to prevent the image data being executed. embedFile :: FilePath -> Lazyboy Label embedFile file = do label <- getGlobalLabel