[Uml-devel] force docu and sections

[Luis De la Parra Blum]

On Tuesday 22 October 2002 02:59, Jonathan Riddell wrote:
> Say Luis, what's Force documentation  and  Force Sections ?

Force documentation means that there is going to be a comment block for the 
class and each of the mehtods, even if you didnt write any documentation for 
them. for example

/** class Example
 *
 */
 class Example
{
 //public section
public:
/**
 */
void thisIsAMethodThatISNotDocumented();
/**
 * this is a method that has documentation and uses a
 * @param a 
 */
 void anotherMehtod(int a);
};

If there is documentation for the class and/or method, then it's written to 
the source, and if there is no documentation (class documentation and first 
method for this example) you can force the program to still write the comment 
blocks (so that you can add it later)

Also, in the class declaration there are comments indicating where the 
different sections begin (public, protected, private, attributes, 
aggretations, etc)
normally this comments are only written if there is somthing in that section 
(ie, it wont write "//protected" if there are no protected methods, but if 
you want to you can force this as well...

hope its clear.

luis.