README.md

ace3-functions-reader

Parses ACE3 addons folders and functions files for documentation

Can return only comments or entire function files, with function names resolved

Usage

var ace3reader = require('ace3-functions-reader')
let ace3RootDir = 'C:/ace3'
ace3reader.getFunctions(ace3RootDir, function (e, functions) {
  console.log(functions)
})

Options

Second argument

{
  onlyComments: false // default true
}

Output

Example:

{
  "component_name": [
    {
      "name": "ACE_component_fnc_function",
      "text": "Entire file or only comments",
      "file": "component/functions/fn_function.sqf"
    }
  ],
  "component_name2": [
    {
      "name": "ACE_component2_fnc_function",
      "text": "Entire file or only comments",
      "file": "component2/functions/fn_function.sqf"
    }
  ]
}

License

ISC