P O G O
Generated Documentation
Description.
The documentation will be generated in html format,
in a sub directory doc_html under source files directory.
This documention is organized in 5 parts:
- 1 - Device Description:
This file is generated only if it does not already exist.
It mut be filled by the programmer to describe device or
every thing else, and it will not be overwritten during an
other generation.
- 2 - States Description:
The states list is displayed in an array with the description
of each one.
- 3 - Commands Description:
A list of the commands with arguments, descriptions and states
which allow the commands is generated.
An abstract display in an array the commands list
with the arguments of each one.
- 4 - Attributes Description:
The attributes list is displayed in an array with the argument type
of each one.
- 5 - Programmer's guide (Software Description):
It is the documentation generated by Doc++ or
javadoc from the source file generated by POGO.