chore(typesetters,outputters,packages): Clean in-code comments

No code change
sile-typesetter · Aug 23, 2023 · d365af8 · d365af8
1 parent 01d12c7
commit d365af8
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/outputters/base.lua b/outputters/base.lua
@@ -34,11 +34,11 @@ function outputter.debugFrame (_, _, _) end
 
 function outputter.debugHbox (_, _, _) end
 
-function outputter.linkAnchor (_, _, _) end
+function outputter.linkAnchor (_, _, _) end -- Unstable API
 
-function outputter.enterLinkTarget (_, _, _) end
+function outputter.enterLinkTarget (_, _, _) end -- Unstable API
 
-function outputter.leaveLinkTarget (_, _, _, _, _, _, _) end
+function outputter.leaveLinkTarget (_, _, _, _, _, _, _) end -- Unstable API
 
 function outputter.setMetadata (_, _, _) end
 

diff --git a/outputters/libtexpdf.lua b/outputters/libtexpdf.lua
@@ -47,6 +47,8 @@ function outputter:_ensureInit ()
   if not started then
     local w, h = SILE.documentState.sheetSize[1], SILE.documentState.sheetSize[2]
     local fname = self:getOutputFilename()
+    -- Ideally we could want to set the PDF CropBox, BleedBox, TrimBox...
+    -- Our wrapper only manages the MediaBox at this point.
     pdf.init(fname == "-" and "/dev/stdout" or fname, w, h, SILE.full_version)
     pdf.beginpage()
     started = true

diff --git a/packages/cropmarks/init.lua b/packages/cropmarks/init.lua
@@ -7,7 +7,7 @@ local outcounter = 1
 
 local function outputMarks ()
   local page = SILE.getFrame("page")
-  -- Length of cromark bars
+  -- Length of crop mark bars
   local cropsz = 20
   -- Ensure the crop marks stay outside the bleed area
   local offset = math.max(10, SILE.documentState.bleed / 2)

diff --git a/typesetters/base.lua b/typesetters/base.lua
@@ -940,14 +940,12 @@ function typesetter:makeHbox (content)
         local ox = atypesetter.frame.state.cursorX
         local oy = atypesetter.frame.state.cursorY
         SILE.outputter:setCursor(atypesetter.frame.state.cursorX, atypesetter.frame.state.cursorY)
-        -- BEGIN SILEX FIX DEBUG
         SU.debug("hboxes", function ()
-          -- setCursor also invoked by the internal hboxes etc.
+          -- setCursor is also invoked by the internal (wrapped) hboxes etc.
           -- so we must show our debug box before outputting its content.
           SILE.outputter:debugHbox(box, box:scaledWidth(line))
           return "Drew debug outline around hbox"
         end)
-        -- END SILEX FIX DEBUG
         for _, node in ipairs(box.value) do
           node:outputYourself(atypesetter, line)
         end