doxylua

    0.0.4 • Public • Published

    DoxyLua

    Another Doxygen Filter for Lua files provided as a npm package for node.js.

    Usage - Generate documentation for lua files.

    1. Install the doxygen package globally: npm install -g doxylua
    2. Config your doxygen's config file: FILTER_PATTERNS = *.lua=doxylua
    3. Run doxygen in your source folder: doxygen DoxyFile

    Usage - View AST of lua file.

    1. Install the doxygen package globally: npm install -g doxylua
    2. doxylua foo.lua --show-ast [--locations]

    Tests

    1. Install the doxygen package nodeunit: npm install -g nodeunit
    2. In this root folder, run commandline: nodeunit --reporter tap test

    Comments Sample

    ---------------------------------------------------------------------------------
    -- @author dreamlover
    -- @brief This is a sample lua file with comments.
    ---------------------------------------------------------------------------------
     
    ---------------------------------------------------------------------------------
    -- This SomeEnum structure.
    SomeEnum = {
        Enum1 = 1, --- This is Enum1.
        Enum2 = 2, --- This is Enum2.
        Enum3 = 3, --- This is Enum3.
    }
     
     
    --- This is global variable gVar1.
    gVar1 = 1
     
    gVar2 = 2 --- This is global variable gVar2.
     
    ---------------------------------------------------------------------------------
    -- This is funcT.
    -- @param arg1 This is arg1.
    -- @param arg2 This is arg2.
    -- @return Return something.
    function funcT(arg1, arg2)
    end
     
    ---------------------------------------------------------------------------------
    -- This is a class.
    CClass = newClass()
     
    ---------------------------------------------------------------------------------
    -- This is CClass's member property prop1.
    CClass.prop1 = nil
     
    CClass.prop2 = nil --- This is CClass's member property prop2.
     
    ---------------------------------------------------------------------------------
    -- This is CClass's member function func1.
    -- @param arg1 This is arg1.
    -- @param arg2 This is arg2.
    -- @return Return something.
    function CClass:func1(arg1, arg2)
        print(tostring(arg1))
        print(tostring(arg2))
    end
     
    ---------------------------------------------------------------------------------
    -- This is CClass's member function func2.
    -- @param arg1 This is arg1.
    -- @param arg2 This is arg2.
    -- @return Return something.
    function CClass:func2(arg1, arg2)
        return tonumber(arg1) + tonumber(arg2)
    end

    Sample output

    alt tag alt tag alt tag

    Install

    npm i doxylua

    DownloadsWeekly Downloads

    8

    Version

    0.0.4

    License

    MIT

    Last publish

    Collaborators

    • free