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
 Document method fails on template
 New Topic  Reply to Topic
 Printer Friendly
Author Previous Topic Topic Next Topic  

graham.reeds
Ketchup Master

United Kingdom
51 Posts

Posted - Jun 15 2007 :  9:18:13 PM  Show Profile  Reply with Quote
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.

feline
Whole Tomato Software

United Kingdom
19014 Posts

Posted - Jun 16 2007 :  1:50:23 PM  Show Profile  Reply with Quote
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

zen is the art of being at one with the two'ness
Go to Top of Page

BrianCBecker
New Member

4 Posts

Posted - Jun 28 2007 :  11:42:23 AM  Show Profile  Reply with Quote
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
Go to Top of Page

feline
Whole Tomato Software

United Kingdom
19014 Posts

Posted - Jun 28 2007 :  12:33:08 PM  Show Profile  Reply with Quote
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

zen is the art of being at one with the two'ness
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