ReferenceFormatter

Inherits: JsonIO > Reference > Object

Description

Sweepes the project and generates the json reference for the codebase. Started this based on ReferenceCollector.gd from GDQuest’s docs maker, but customized it to add to the json some more information I wanted to use.

Methods

return type method signature
null export_formatted_reference_json(Array directories, Array patterns, bool is_recursive, String save_path)

Constants

  • METADATA = {category:@category:} — Currently recognized metadata that you can use in the comments, while documenting your code. @category: - will group pages during export, and save them together in a folder with the same name as the category. If you want to use subcategories you can treat it as path. For example # @category: CategoryA/SubcategoryB will generate a folder named “CategoryA” and inside it a folder named “SubcategoryB”. Only works in the main description for the file.

Method Descriptions

export_formatted_reference_json

  • void export_formatted_reference_json(Array directories, Array patterns, bool is_recursive, String save_path)