Whole Tomato Software Forums
Whole Tomato Software Forums
Main Site | Profile | Register | Active Topics | Members | Search | FAQ
 All Forums
 Visual Assist
 Feature Requests
 Documentation -> Doxygen

You must be registered to post a reply.
Click here to register.

Screensize:
UserName:
Password:
Format: BoldItalicizeUnderlineStrikethrough Align leftCenterAlign right Insert horizontal ruleUpload and insert imageInsert hyperlinkInsert email addressInsert codeInsert quoted textInsert listInsert Emoji
   
Message:

Forum code is on.
Html is off.

 
Check to subscribe to this topic.
   

T O P I C    R E V I E W
verifier Posted - Sep 27 2006 : 02:35:58 AM
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.
5   L A T E S T    R E P L I E S    (Newest First)
feline Posted - Sep 30 2006 : 11:27:12 AM
using VA 1535 and VS2003 i placed your prototype into a C++ header file, and edited the autotext entry for document method to read:

/**
 * $end$
 *
 * @param $MethodArgName$
 * @return $SymbolType$
 */



and triggered document method on the prototype i ended up with:

/**
 * |
 *
 * @param nRow
 * @param nCol
 * @param str
 * @return void
 */


which seems to be the correct template for what you want. the red bar is where my caret was positioned

which version of VA are you using? if you are using a very early 15xx build then document method may not support some of these features.

do you have a lot of function pointers, or other types with brackets in them in your parameters?
sean Posted - Sep 28 2006 : 12:32:06 PM
quote:
Originally posted by verifier

$MethodArg$ adds all arguments to the same line (cant describe the methods then)



Can you post a some examples of the output you are getting?
rhummer Posted - Sep 28 2006 : 12:04:34 PM
$MethodArg$ and its variants put each one in a new line.

so if I have void foo( int bar, int fooBar )

document method for the parameters would produce.

// Parameter: int bar
// Parameter: int foobar

Though, there could be a new keyword similar to the special flags that prompt for input. That would generate one for each parameter. something like $MethodArgComment$

case=2781
verifier Posted - Sep 28 2006 : 11:51:04 AM
yes, but that doesnt help.

$MethodArg$ adds all arguments to the same line (cant describe the methods then)

All other $$ variables doesnt help.
rhummer Posted - Sep 28 2006 : 11:45:04 AM
You can edit the format of Document Method, via the AutoText entry called 'Refactor Document Method'

Read this page on our site to learn about the autotext keywords for document method.

http://www.wholetomato.com/products/features/documentMethod.asp

© 2023 Whole Tomato Software, LLC Go To Top Of Page
Snitz Forums 2000