Auto Documentation: Difference between revisions
No edit summary |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[File:Gen_Project_Report_Export_Wizard_01.png|right]] | [[File:Gen_Project_Report_Export_Wizard_01.png|right]] | ||
Auto-generated documentation consists of technical information taken directly from | Auto-generated documentation consists of technical information taken directly from your project and consists of information such as its name and description, along with details of the [[Editing Variables|variables]], [[Creating_a_New_Macro|macros]], and [[Component|components]] used within the project. | ||
| Line 6: | Line 6: | ||
To do this you go to the '''File >> | To do this you go to the '''File >> Export >> Make information about your project available in HTML format''' option within Flowcode. | ||
This information is taken directly from Flowcode and exported into a HTML document, where all the information will be formatted and organised to include tables and images etc. | This information is taken directly from Flowcode and exported into a HTML document, where all the information will be formatted and organised to include connections, tables, properties and images etc. | ||
| Line 19: | Line 19: | ||
*[[Variable Types]] | *[[Variable Types]] | ||
*[[Components]] | *[[Components]] | ||
*[[ | *[[Simulation Events]] | ||
*[[ | *[[Simulation Functionality]] | ||
Latest revision as of 16:19, 23 July 2026
Auto-generated documentation consists of technical information taken directly from your project and consists of information such as its name and description, along with details of the variables, macros, and components used within the project.
You can 'Create a Project Report' of your own Flowcode file to auto-generate documentation of your project in different styles, from an overall report to flowchart images and even flowchart source code, the report covers the contents of your Flowcode file, from chip and compiler settings to macros and variables.
To do this you go to the File >> Export >> Make information about your project available in HTML format option within Flowcode.
This information is taken directly from Flowcode and exported into a HTML document, where all the information will be formatted and organised to include connections, tables, properties and images etc.
In regards to the auto-documentation for the wiki, there are then fields and areas left to complete such as detailed descriptions and an examples and further information regarding a function, component or property etc.
By default these fields contain red text saying "No additional information", or "No additional examples". These fields are then filled out on the wiki to provide further information about the specified area.
This documentation provides technical information regarding Flowcode, examples of this on the wiki are as follows: