Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

Generating documentation for Lua

Support
Daniel
2012-06-07
2012-09-14
  • Daniel
    Daniel
    2012-06-07

    I've been trying to get NaturalDocs to work with Lua, but so far without
    success.

    In the Laanguage.txt file I added the following:

    Language: Lua
      Extension: lua
      Line Comment: -- //
      Block Comment: [[ ]] --[[ --]] --[[ ]]
      Function Prototype Enders: end \n
      Variable Prototype Ender: \n
    

    But after running Natural Docs, the documentation just shows an empty web
    page. I've been looking through the internet for a solution, but I've only
    found different configurations for the "Languages.txt" file (different
    Function prototype enders, block comments symbols, etc)

    I haven't modifying anything, besides that, from the default settings.

    I don´t know if maybe I'm missing something else.

    Thanks for your support on this!

     
  • Greg Valure
    Greg Valure
    2012-06-07

    Did you write comments in Natural Docs' format? It's described here:

    http://www.naturaldocs.org/documenting.html

    Since Lua has basic language support it won't be able to go through your code
    and find all the functions and stuff on its own, it will only pick out the
    comments you specifically write for it.

    If you did that already, post some code and I can take a look at it.