bdocs

Extracts the types, functions and documentation of a project into a json file for further use. It uses the TypeDeclaration.TypeDeclarations, so it doesnt document Comptime generated code, which is fine, since thats usually usage dependent.

Usage

• Rightclick on the Workspace where you want to extract the file to
• Generate File
• Select New Documentation in the Dropdown
• FileName is the name of the output file
• Target Namespace allows you to specificy which Namespace should be extracted (This uses a .StartsWith internally, so it will also parse sub namespaces)
• ìgnore private members will exclude private functions from being extracted unless they are marked with the ForceDocs attribute
• ignore default functions will exclude predefined functions
• The output is a minified json file

Platforms

Generators are currently limited to Beef IDE on Windows, which means that you cannot extract the documentation in the cli or on linux systems, but instead need to do it manually. Future Releases may have a way to run this code from a Test instead of only being available through the generator