Difference between revisions of "Auto Documentation"

From Flowcode Help
Jump to navigationJump to search
Line 1: Line 1:
 
<sidebar>Sidebar: Adding Finishing Touches</sidebar>
 
<sidebar>Sidebar: Adding Finishing Touches</sidebar>
Auto-generated documentation is information regarding [[API overview|API Functions]], [[Components]] and [[Variable Types]] for example.
+
Auto-generated documentation is information consisting of the technical data stored within Flowcode, such as [[API overview|API Functions]], [[Components]] and [[Variable Types]].
  
This information is taken directly from Flowcode and imported into the wiki, there are then fields left to complete such as a detailed description and an example of the function, component etc. By default these fields contain red text saying "No additional information", or "No additional examples".
+
This information is taken directly from Flowcode and imported into the wiki, there are then fields and areas left to complete such as a detailed description and an examples and further information about a function, component etc. By default these fields contain red text saying "No additional information", or "No additional examples".

Revision as of 15:07, 8 August 2013

<sidebar>Sidebar: Adding Finishing Touches</sidebar> Auto-generated documentation is information consisting of the technical data stored within Flowcode, such as API Functions, Components and Variable Types.

This information is taken directly from Flowcode and imported into the wiki, there are then fields and areas left to complete such as a detailed description and an examples and further information about a function, component etc. By default these fields contain red text saying "No additional information", or "No additional examples".