It' seems that the "Document Member" function only works in the implementation file.
I personally document all members in the header file, and use the Doxygen or Javadoc syntax:
/**
* \\short A short introduction
*
* Longer description
*
* \\date 2007-07-19
* \\author NameofAuthor
* \\param a The description for parameter a
* \\param b The description for parameter b
* \\param c The description for parameter c
* \\param d The description for parameter d
* \\return A description of the return value.
*/
Or the same Javadoc compatible:
/**
* A short introduction.
*
* Longer description
*
* @date 2007-07-19
* @author NameofAuthor
* @param a The description for parameter a
* @param b The description for parameter b
* @param c The description for parameter c
* @param d The description for parameter d
* @return A description of the return value.
*/
I found no way how to change the autotext entry to create this kind of output.
- I don't need the type only the name (Doxygen extracts this information from the code)
- \\return should only appear, if there is another return value as void
- A default description "ctor" and "dtor" for constructors/destructors
There is another problem with the return value:
namespace x {
namespace y {
//************************************
// Method: foo
// FullName: x::y::Foo::foo
// Access: private
// Returns: void Foo::
// Qualifier:
// Parameter: X hiSide
// Parameter: Y slot1
// Parameter: Y slot2
// Parameter: Y slot3
// Parameter: Y right1
// Parameter: Y left1
// Parameter: Y right2
// Parameter: Y left2
// Parameter: Y right3
// Parameter: Y left3
//************************************
void Foo::foo(
X hiSide,
Y slot1,
Y slot2,
Y slot3,
Y right1, Y left1,
Y right2, Y left2,
Y right3, Y left3 )
{
The name of the class is copied into the return value.
1530: Refactor, Document Member, only in impl.
Posted - Jul 19 2006 : 05:11:49 AM
