//************************************
// Method:    $SymbolName$
// FullName:  $SymbolContext$
// Access:    $SymbolVirtual$$SymbolPrivileges$$SymbolStatic$
// Returns:   $SymbolType$
// Qualifier: $MethodQualifier$
// Parameter: $MethodArg$
//************************************

quote:

---

Originally posted by feline

First up, are you using the Document Method refactoring command, or are you triggering a snippet by typing its shortcut into the editor, or selecting it from a menu?

If you trigger the Document Method snippet, then you can set this to enter the method name, its return type, the parameters, and specify the comment structure you want to use.

For example, the Document Method snippet:

//************************************
// Method:    $SymbolName$
// FullName:  $SymbolContext$
// Access:    $SymbolVirtual$$SymbolPrivileges$$SymbolStatic$
// Returns:   $SymbolType$
// Qualifier: $MethodQualifier$
// Parameter: $MethodArg$
//************************************

will expand all of the $$ tokens above when Document Method is triggered on a method, and the Parameter comment line will be repeated for each parameter the function takes.

This works perfectly well in VC6, so if you can explain what you are doing, I can try to help you get this working correctly.

---

/*
 * @method $SymbolName$
 * @FullMethod $SymbolContext$
 * @access $SymbolVirtual$$SymbolPrivileges$$SymbolStatic$
 * @return $SymbolType$
 * @qualifier $MethodQualifier$
 * @parameter $MethodArg$
 */

static void simpleVc6DoxygenFormatTest(int nParamOne, int nParam2);

/*
 * @method simpleVc6DoxygenFormatTest
 * @FullMethod simpleVc6DoxygenFormatTest
 * @access public static 
 * @return void
 * @qualifier
 * @parameter int nParamOne
 * @parameter int nParam2
 */
static void simpleVc6DoxygenFormatTest(int nParamOne, int nParam2);

quote:

---

Originally posted by feline

What VA snippet are you editing?
What are you setting it to?
Can you post a sample function declaration that you are triggering Document Method on, and the comment that VA is then inserting for you?

Using VC6, VA 2217 under Windows 7, I have set the Snippet "Refactor Document Method" to the code:

/*
 * @method $SymbolName$
 * @FullMethod $SymbolContext$
 * @access $SymbolVirtual$$SymbolPrivileges$$SymbolStatic$
 * @return $SymbolType$
 * @qualifier $MethodQualifier$
 * @parameter $MethodArg$
 */

and then I triggered Document Method on the function:

static void simpleVc6DoxygenFormatTest(int nParamOne, int nParam2);

which produced the following comment block:

/*
 * @method simpleVc6DoxygenFormatTest
 * @FullMethod simpleVc6DoxygenFormatTest
 * @access public static 
 * @return void
 * @qualifier
 * @parameter int nParamOne
 * @parameter int nParam2
 */
static void simpleVc6DoxygenFormatTest(int nParamOne, int nParam2);

I have just guessed at the correct formatting and tag names for Doxygen comments, since as I recall there are at least 2 different supported formats, and many possible tags. However, as you can see, this is working perfectly well for me here. So I am wondering what I am doing differently to you.

---

quote:

---

Originally posted by feline

The refactoring snippets are special snippets, that are used by the refactoring commands. These enable the snippets to access and insert scope specific information that would otherwise not be known.

So to update one of the refactoring snippets, you have to edit the actual refactoring snippet. Making a new snippet with a similar name will have no effect on the refactoring command.

Have you now updated the actual, pre-existing refactoring document method snippet?

---