Whole Tomato Software Forums
Whole Tomato Software Forums
Main Site | Profile | Register | Active Topics | Members | Search | FAQ
User name:
 Password:
Save Password
Forgot your password?

 All Forums
 Visual Assist
 Technical Support
 Doxygen format documentation		  New Topic  Reply to Topic
 Printer Friendly
Author Previous Topic Topic Next Topic  

John Dexter
Junior Member

United Kingdom
12 Posts
Posted - Oct 17 2011 :  11:17:09 AM  Show Profile  Reply with Quote
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*
Edited by - feline on Oct 17 2011 1:36:06 PM

feline
Whole Tomato Software

United Kingdom
19024 Posts
Posted - Oct 17 2011 :  1:38:13 PM  Show Profile  Reply with Quote
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
zen is the art of being at one with the two'ness
Go to Top of Page

John Dexter
Junior Member

United Kingdom
12 Posts
Posted - Dec 30 2011 :  08:02:51 AM  Show Profile  Reply with Quote
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?
Go to Top of Page

feline
Whole Tomato Software

United Kingdom
19024 Posts
Posted - Jan 02 2012 :  6:25:57 PM  Show Profile  Reply with Quote
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.
zen is the art of being at one with the two'ness
Edited by - feline on Jan 02 2012 6:26:42 PM
Go to Top of Page
  Previous Topic Topic Next Topic  
 New Topic  Reply to Topic
 Printer Friendly
Jump To:
© 2023 Whole Tomato Software, LLC Go To Top Of Page
Snitz Forums 2000