It's nice that you added the "Document Method" feature. Can you support doxygen tags in it instead of the current layout?
Your example would look like:
/**
* Here is an description that the user
* should enter himself. There is no need
* to enter the parameter types since
* they are displayed anyway by
* intellisense.
*
* @param nRow Row of the cell, 0-based.
* @param nCol Column of the cell, 0-based.
* @param str New string that the cell should display
*/
void OnEndEditCell(int nRow, int nCol, CString str);
The documentation should be added to the header and not the cpp file. The cpp files can grow quite large anyway.
there's also a "@return" tag, but it's only used to desribe what is actually return (for instance why true and not false was returned for bool).
Also, theres a "@throws" tag that explains why an exception is thrown (one per exception).
As for now, the documentation that is added is unfortunally quite useless since you get exactly the same information from intellisense/VA.
Documentation -> Doxygen
Posted - Sep 27 2006 : 02:35:58 AM
