Auto Documentation - Revision history

MartinW at 15:34, 19 December 2022

2022-12-19T15:34:26Z

2022-12-19T15:33:52Z

2019-07-03T12:05:26Z

2019-07-02T08:02:52Z

2014-03-07T16:49:43Z

2013-09-23T13:28:08Z

2013-09-23T13:26:59Z

2013-09-23T13:26:41Z

2013-08-09T15:08:10Z

2013-08-08T15:42:23Z

← Older revision		Revision as of 15:34, 19 December 2022
Line 6:		Line 6:


−	To do this you go to the '''File >> Export >>Make information about your project available in HTML format''' option within Flowcode.	+	To do this you go to the '''File >> Export >> Make information about your project available in HTML format''' option within Flowcode.

← Older revision		Revision as of 15:33, 19 December 2022
Line 6:		Line 6:


−	To do this you go to the '''File >> ~~Create Project Report...~~''' option within Flowcode.	+	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.

← Older revision		Revision as of 12:05, 3 July 2019
Line 4:		Line 4:

	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.		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 >> Create Project Report...''' 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 tables and images etc.

← Older revision		Revision as of 08:02, 2 July 2019
Line 1:		Line 1:
−	~~<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>~~
	[[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 within Flowcode, for example auto-generated documentation consists of information regarding [[API Overview\|API Functions]], [[Component]] macros, properties and functions as well as information regarding [[Editing Variables\|Variables]].		Auto-generated documentation consists of technical information taken directly from within Flowcode, for example auto-generated documentation consists of information regarding [[API Overview\|API Functions]], [[Component]] macros, properties and functions as well as information regarding [[Editing Variables\|Variables]].

@@ Line 1: / Line 1: @@
-<sidebar>Sidebar: Adding Finishing Touches</sidebar>
+<sidebar>Sidebar: Flowcode Help Overview:ToolsViews</sidebar>
 [[File:Gen_Project_Report_Export_Wizard_01.png|right]]
 Auto-generated documentation consists of technical information taken directly from within Flowcode, for example auto-generated documentation consists of information regarding [[API Overview|API Functions]], [[Component]] macros, properties and functions as well as information regarding [[Editing Variables|Variables]].

@@ Line 13: / Line 13: @@
 By default these fields contain red text saying "''<span style="color:red;">No additional information</span>''", or "''<span style="color:red;">No additional examples</span>''". These fields are then filled out on the wiki to provide further information about the specified area.
-This documentation provides technical information about Flowcode, examples of such content on this wiki are as follows:
+This documentation provides technical information regarding Flowcode, examples of this on the wiki are as follows:
 *[[Variable Types]]
 *[[Components]]
 *[[Event Reference]]
 *[[API Reference]]

@@ Line 5: / Line 5: @@
 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.
 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.
@@ Line 13: / Line 12: @@
 By default these fields contain red text saying "''<span style="color:red;">No additional information</span>''", or "''<span style="color:red;">No additional examples</span>''". These fields are then filled out on the wiki to provide further information about the specified area.
 This documentation provides technical information about Flowcode, examples of such content on this wiki are as follows: