Documentation from C headers

[rodrigo-dc]

Hi.

I have created my very first pandoc Lua filter: https://codeberg.org/rodrigo-dc/documento.git

It basically extracts documentation from a C header file and inserts it in the document. You can control how/where the documentation will be inserted by using "tags" like %ALL%.

I would really appreciate any input, specially regarding the pandoc-specific code.

Thanks

[tarleb]

Very cool! I love how you are using Lpeg to parse the code.

[rodrigo-dc]

Thanks. I started doing this in Lua just because of Lpeg. My first idea was to manually generate some markdown output, but then I found out about these Lua filters in pandoc.

[bpj]

It is probably more efficient to assemble patterns used in functions outside the function so that they are assembled only once and not every time the function is called. If you want to keep the variables more localized you can create a scope with a do block

local my_function
do
  my_pattern = (assemble pattern)
  my_function = function(args)
    -- my_pattern is visible here
  end
end
-- function works here but variable is invisible

[rodrigo-dc]

It is probably more efficient to assemble patterns used in functions outside the function so that they are assembled only once and not every time the function is called.

Yes, you are right. I just fixed that :)

If you want to keep the variables more localized you can create a scope with a do block

I didn't know I could use a do-end like this. Thanks for the tip!