How to document Lua code with LDoc

Solar2D Lua Language
#1

Hi everyone,

I wrote an article about documenting Lua code with LDoc.

LDoc is a Lua program that scans your Lua files and generates nice HTML documentation.

In my article I show you

  • how to install and run LDoc
  • how to use it with Sublime Edit
  • how to create the docs for a whole project
  • how to customize your HTML doc output

Hope this is useful to someone.

Best

René

Link to the article

http://devilsquid.com/how-to-get-a-better-coder-by-documenting-lua-code-like-a-pro/

#2

Nice info. LDoc is a great tool.

Cheers. 

#3

+1, ldoc style alone is worth suggesting even if they never actually install or generate

#4

I found out that in some situtions the LDoc syntax alone is not flexible enough.

(in example options tables as function paramter).

I wrote a second article about adding Markdown support to LDoc so that more complicated code situations can be documented as well.

Here is the link: http://devilsquid.com/why-and-how-to-add-markdown-support-to-gain-more-power-to-your-ldoc-syntax/

#5

Nice info. LDoc is a great tool.

Cheers. 

#6

+1, ldoc style alone is worth suggesting even if they never actually install or generate

#7

I found out that in some situtions the LDoc syntax alone is not flexible enough.

(in example options tables as function paramter).

I wrote a second article about adding Markdown support to LDoc so that more complicated code situations can be documented as well.

Here is the link: http://devilsquid.com/why-and-how-to-add-markdown-support-to-gain-more-power-to-your-ldoc-syntax/