Whole Tomato Software Forums
Whole Tomato Software Forums
Main Site | Profile | Register | Active Topics | Members | Search | FAQ
 All Forums
 Visual Assist
 Technical Support
 Document method fails on template

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
graham.reeds Posted - Jun 15 2007 : 9:18:13 PM
Generally DocumentMethod works on templates. However this template causes it to fail.

This:
/**
 * This is a brief comment about the $SymbolVirtual$$SymbolPrivileges$$SymbolStatic$function $SymbolName$.
 * This is the longer description about $SymbolName$.
 * @param	$MethodArgName$	Description of $MethodArgName$.
 * @return	$SymbolType$ The return types.
 */

causes this documentation:
/**
 * This is a brief comment about the public function from_string.
 * This is the longer description about from_string.
 * @param	t	Description of t.
 * @param	s	Description of s.
 * @param		Description of .
 * @param	f	Description of f.
 * @param		Description of .
 * @return	bool The return types.
 */
template <class T>
bool from_string(T& t, 
                 const std::string& s, 
                 std::ios_base& (*f)(std::ios_base&))
{
    std::istringstream iss(s);
    return !(iss >> f >> t).fail();
}


Thanks, G.
3   L A T E S T    R E P L I E S    (Newest First)
feline Posted - Jun 28 2007 : 12:33:08 PM
I am seeing the same effect here. Thank you for the clear description. Now you point it out the comma does seem to be the trigger for this, and also in the other example of this I found:

case=1356
BrianCBecker Posted - Jun 28 2007 : 11:42:23 AM
Hi,

I would also like to report a problem with the document method on templates that is possibly related.

With the following autotext:

////////////////////////////////////////////////////////////////////////////////
///
/// \\brief $end$
///
/// \\param $MethodArgName$
///
/// \\return
///
////////////////////////////////////////////////////////////////////////////////

Double templates fail to work for the $MethodArgName$

////////////////////////////////////////////////////////////////////////////////
///
/// \\brief
///
/// \\param
/// \\param a
///
/// \\return
///
////////////////////////////////////////////////////////////////////////////////
void dostuff(Foobar<int, int> a)
{

}

Notice an extra blank name is parsed, probably because of the comma in the template. Using $MethodArg$ yields:

////////////////////////////////////////////////////////////////////////////////
///
/// \\brief
///
/// \\param Foobar<int
/// \\param int> a
///
/// \\return
///
////////////////////////////////////////////////////////////////////////////////

I'm using VS2005 SP1 with VAX 1557. Thanks.

Sincerely,
Brian C. Becker @ www.BrianCBecker.com
feline Posted - Jun 16 2007 : 1:50:23 PM
I am seeing the same effect here. Thank you for the clear description. The problem is actually the function pointer parameter, not the fact it is a template function.

case=7124

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