Document Generator

[Andreas]

Hi there,

Can somebody point me to a manual for the document generator which is built into the CCS Compiler ??

I am trying to make a documentation, but cant find out how to insert project title, author and all this %...% Variables used throughout the document

best regards
Andreas

[PCM programmer]

See this thread for comments about the document generator:
http://www.ccsinfo.com/forum/viewtopic.php?t=36158

[dyeatman]

Here is some info on how it is used. It has worked fine for me lately. Please note the last paragraph (bolded) that shows an example of how it is used. Also see the file titled "template_sdd.rtf" in the PICC directory for an example template..

The following tags are used to identify a group that should be repeated for every function in the program.
%FOR EACH FUNCTION% - Start tag
%END FOR% - End tag
Inside the above tags, the following refer to the individual functions:
%F:FUNCTION% - The function name
%F:DESCRIPTION% - Un-named comments associated with this function.

The following special markups are lists. If they appear inside a table, then the table rows are duplicated for each item in the
list. If they are outside a table then the items are listed one per line.
%S:SOURCEFILES% - This is a list of source files
%S:OUTPUTFILES% - This is a list of output files
%D:ID% - A list of #defines
%D:VALUE% - A list of #define values
%D:DESCRIPTION% - A list of #define comments
%T:ID% - A list of TYPEDEF's
%T:TYPE% - A list of TYPEDEF values
%T:DESCRIPTION% - A list of TYPEDEF comments
%G:ID% - A list of global variables
%G:TYPE% - A list of global variable types
%G:DESCRIPTION% - A list of global variable comments
%L:ID% - A list of local variables
%L:TYPE% - A list of local variables types
%L:DESCRIPTION% - A list of local variables comments

Any other string of the form %identifier% is considered as a user defined named comment. It is associated with the
corresponding comment in the source code.
Note: The named comment is case sensitive.

For example: In your source code, if you wish to place the following named comment:
//*AUTHOR John Doe.
In your template you will include the following markup:
%AUTHOR%
This markup will be replaced by text in your source code – “John Doe” in this case.