Search code examples
documentationluadocumentation-generationluadoc

How to use LuaDoc with LuaForWindows

The question is all in the title : how to use LuaDoc with LuaForWindows ?

In my Lua installation, I have a luadoc_start.bat but the command windows closes as soon as it opens. From there I don't know what else can I do.

Any help ? Thanks

Solution

  • For using luadoc in Lua For Windows, the command is like this:

    luadoc_start.bat path\to\lua\file\name.lua

    which is to be done in either the command prompt window, or powershell.

    I get a doc file to properly generate but how to do it for the whole project? I understand there is a -d argument but I am not sure how to use it, none of my tries where successful.

    For this task, you'll need to write a shell script. Here's a small script.

    $files = Get-ChildItem .\
foreach( $file in $files ) {
    luadoc_start.bat "$file"
}

    Where, you have to cd to the path\to\lua\file directory and run this PS1 file.