incubator-stdcxx-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Travis Vitek" <Travis.Vi...@roguewave.com>
Subject RE: svn commit: r667636 - /stdcxx/branches/4.3.x/include/rw/_forward.h
Date Mon, 23 Jun 2008 16:13:10 GMT
 

Martin Sebor wrote:
>
>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?
>

I know that it was requested that I remove the doxygen comments from the
type traits stuff I have been working on, but I decided it would be best
to commit them with the comments intact and remove them only if
necessary. I mentioned this to Brad in our off-list correspondence, and
he has opted to do the same.

As I sit here thinking about it, I can't remember exactly why it was
decided that they should be removed. Perhaps it is best to have this
discussion again, but on the list this time.

To start, I'm not sure I understand the motivation for _not_ using
doxygen in the library headers. I realize that having documentation in
the code is a departure from what stdcxx has done in the past, but I'm
not convinced that this is a bad thing.

Travis

>Martin
>
>> 
>> http://www.stack.nl/~dimitri/doxygen/commands.html#cmdtparam
>> 
>> Brad.

Mime
View raw message