Whole Tomato Software Forums

Whole Tomato Software Forums

All Forums

Visual Assist

Technical Support

Doxygen format documentation

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

Screensize:

UserName:

Password:

Format:

Message:

Forum code is on.
Html is off.

Check to include your profile signature.
Check to subscribe to this topic.

T O P I C R E V I E W
John Dexter	Posted - Oct 17 2011 : 11:17:09 AM Is there a easy way to use VAX to create skeleton doxygen-format comments on method/class names? The "document method" functionality seems to use a fairly generic formatting. moved to the general release section by Feline
3 L A T E S T R E P L I E S (Newest First)
feline	Posted - Jan 02 2012 : 6:25:57 PM It is quite some time since I have used doxygen, but based on one of the samples here: http://en.wikipedia.org/wiki/Doxygen You might find this Document Method snippet to be a good start point: /** * @param $MethodArgName$ * @return $SymbolType$ */ Based on this sample I am assuming Doxygen works out the function make automatically, but that is just an assumption. You can easily tell Document Method to add this to the comment block.
John Dexter	Posted - Dec 30 2011 : 08:02:51 AM I totally missed this reply, thanks a lot. It seems like something someone must have already done... as an expert in neither doxygen or VAX, I'd like to ask if anyone has got a snippet they would share before I take it on myself?
feline	Posted - Oct 17 2011 : 1:38:13 PM Document Method is controlled by the "Refactor Document Method" VA Snippet: http://www.wholetomato.com/products/features/documentMethod.asp If you edit this snippet to use Doxygen format, then you will get Doxygen format comments when you use the Document Method refactoring command. You can also make VA Snippets for specific comment blocks, or parts of comment blocks that you might want to add: http://www.wholetomato.com/products/features/vasnippets.asp

Snitz Forums 2000