Create class documentation report

[aGrahamAtFES]

I am trying to create a custom template to generate the class documentation for our system.  We would like it to match our existing documents which look like the following:

{MethodName}
{Method Notes}

Declaration	{Full Method signature}
Parameters	{list of parameters along with notes}
Return	{return type}
Remarks	{Method Behavior}

I have not been able to find a template that comes close to that nor have I been able to create my own template.  Anyone have any examples that can help me?

[Dermot]

The {basic template} does cover the man Method and Parameter data, but you would need to add further fields to this from the Method Section.  If you need more information on copying this and modifying your copy to suitthis, see the whitepaper or RTF reports (or EA's help on this): http://www.sparxsystems.com.au/resources/whitepapers/index.html

[aGrahamAtFES]

I have read the help and whitepapers but I do not see how to create separate tables for each method with the headers in the first column?

[aGrahamAtFES]

I am getting closer, now that I updated to 833.  

i still need to find out how to get the header to repeat for each table and to get the full function declaration

[Dermot]

The header row is automaticlay removed for any rows post the first row.  The trick is to create a blank row of minum height (with the font set to minumum size) - keep this as the rown that will be removed and place your header detail in the next row.
I am not sure what you mean by the full function decalration - if it is the code - the output of this is not supported in the RTF reporting.

[aGrahamAtFES]

The header row is automaticlay removed for any rows post the first row.

Yep I have figured this out

I am not sure what you mean by the full function decalration - if it is the code - the output of this is not supported in the RTF reporting.

I want to see in "int Foo(in int X, in int Y)" on the declaration line.

[aGrahamAtFES]

I am also having issues with adding numbering to my sections.  It seems that if I have headings in the tables that the numbering is getting messed up.

This is what I get in the table of contents(and the same in the body)
1.    OrderDistribution       1
1.1    IOrderDistributionManager      1
1.1.1    Operations      2
1.1.1.1.0.0    CancelOrder      2 <-- This is created from a section header in a table
1.1.1.1.0.1    CheckStatus      2 <-- This is created from a section header in a table


I have created a custom list and overrides, as is described in the help under user numbering, setting every list level to start at 1.

I can send you the template if you would like to look at it.

[Dermot]

For each parse down the Project tree - the heading font is incremented.  So the last section is usng the highest value heading font which may not have been set in the list numbering as yet.  I would suggest you check the font for these rows and check your numbering configuaration.

[aGrahamAtFES]

All of the levels are set to start at 1, and override the font attributes.
The headers in the table are set to be list level 4, but generates level 6.  I have been able to fake it out to generate correctly if I set the list level to be level 2 instead of 4.  

So there seem to be 2 issues with the numbering,
1.) the wrong level is generated
2.) the wrong start at is used.

plus I still need to figure out how to have  "int Foo(in int X, in int Y)" on the declaration line.

[Dermot]

Are you sure the "List Overides" are the same - even though the levels are different.

Regarding the declaration line -see Element::Method & Element::Method:: Parameters
I.e. something like:
method >
{meth.Name}(parameter > {methParameter.Name}:  {MethParameter.Type}, < parameter )
< method

[aGrahamAtFES]

Are you sure the "List Overides" are the same - even though the levels are different.

yes they are all the same

Regarding the declaration line -see Element::Method & Element::Method:: Parameters
I.e. something like:
method >
{meth.Name}(parameter > {methParameter.Name}:  {MethParameter.Type}, < parameter )
< method

But then how can I have the parameters also displayed in the next row of the table with their documentation?

i.e.
Foo
This is Foo documentation
Declaration       int Foo(in int X)
Parameters       X:in int
                        Documentation of X
Return       int