Jump to content

[TOPIC: topicViewTemplate]
[GLOBAL: userSmallPhoto]
Photo

How to document Lua code with LDoc
Started by DevilSquid – René Jan 29 2016 07:12 AM

- - - - -
3 replies to this topic
[TOPIC CONTROLS]
This topic has been archived. This means that you cannot reply to this topic.
[/TOPIC CONTROLS]
[modOptionsDropdown]
[/modOptionsDropdown]
[reputationFilter]
[TOPIC: post.html]
#1

DevilSquid – René

[GLOBAL: userInfoPane.html]
DevilSquid – René
  • Contributor

  • 157 posts
  • Corona SDK

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/



[TOPIC: post.html]
#2

Develephant

[GLOBAL: userInfoPane.html]
Develephant
  • Corona Geek

  • 1,470 posts
  • Corona SDK

Nice info. LDoc is a great tool.

 

Cheers. 



[TOPIC: post.html]
#3

davebollinger

[GLOBAL: userInfoPane.html]
davebollinger
  • Corona Geek

  • 1,373 posts
  • Corona SDK

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



[TOPIC: post.html]
#4

DevilSquid – René

[GLOBAL: userInfoPane.html]
DevilSquid – René
  • Contributor

  • 157 posts
  • Corona SDK

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/




[topic_controls]
[/topic_controls]