stdcxx-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Martin Sebor <se...@roguewave.com>
Subject Re: svn commit: r667636 - /stdcxx/branches/4.3.x/include/rw/_forward.h
Date Mon, 23 Jun 2008 15:17:55 GMT
Eric Lemings wrote:
>  
> Gah.  I have to update my docs as well: template parameters are
> documented using the @tparam tag rather than the @param tag.

I thought we said we wouldn't be using doxygen comments in
library code. Am I misremembering?

Martin

> 
> http://www.stack.nl/~dimitri/doxygen/commands.html#cmdtparam
> 
> Brad.
> 
>> -----Original Message-----
>> From: Travis Vitek 
>> Sent: Monday, June 16, 2008 11:47 AM
>> To: Eric Lemings
>> Subject: RE: svn commit: r667636 - 
>> /stdcxx/branches/4.3.x/include/rw/_forward.h
>>
>>
>> Damn, now I have to update my dox. 
>>
>>> -----Original Message-----
>>> From: Eric Lemings 
>>> Sent: Monday, June 16, 2008 10:44 AM
>>> To: Travis Vitek
>>> Subject: RE: svn commit: r667636 - 
>>> /stdcxx/branches/4.3.x/include/rw/_forward.h
>>>
>>>
>>>
>>>> -----Original Message-----
>>>> From: Travis Vitek 
>>>> Sent: Monday, June 16, 2008 10:21 AM
>>>> To: Eric Lemings
>>>> Subject: RE: svn commit: r667636 - 
>>>> /stdcxx/branches/4.3.x/include/rw/_forward.h
>>>>
>>>>
>>>>  
>>>>
>>>>> Author: elemings
>>>>> Date: Fri Jun 13 13:16:06 2008
>>>>> New Revision: 667636
>>>>>
>>>>> +/**
>>>>> + * An identity wrapper.  Similar to the identity property, 
>>>>> the identity
>>>>> + * wrapper is a class template that simply reflects the 
>> type of its
>>>>> + * template parameter.  This class template is used when 
>> a template
>>>>> + * parameter type must be explicitly specified in order to 
>>> apply the
>>>>> + * correct move/forwarding semantics, usually in the \c 
>>>> std::forward()
>>>>> + * function.
>>>>> + *
>>>>> + * @param _Type Any type.  No restrictions or requirements.
>>>>> + * @see std::forward
>>>>> + */
>>>>> +template <class _Type>
>>>>> +struct identity
>>>> Does doxygen handle @param when we are talking about a 
>>>> template parameter?
>>> Not yet.
>>>
>>> http://www.mail-archive.com/debian-bugs-closed@lists.debian.org
>>> /msg163022.html
>>>


Mime
View raw message