stdcxx-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Martin Sebor <>
Subject Re: svn commit: r667636 - /stdcxx/branches/4.3.x/include/rw/_forward.h
Date Tue, 24 Jun 2008 12:54:49 GMT
Eric Lemings wrote:
> On Jun 23, 2008, at 9:31 PM, Martin Sebor wrote:
>> Travis Vitek wrote:
>>> Martin Sebor wrote:
>> [...]
>>>> I gave a number of arguments against Doxygen comments in
>>>> stdcxx headers:
>>>> 1)  existing code doesn't use it and converting the raw HTML
>>>>    docs to Doxygen is an enormous task that none of us has
>>>>    the time to take on; Doxygenating new code without doing
>>>>    the same for the existing code is inconsistent and won't
>>>>    help us produce end-user documentation for the finished
>>>>    product
>>> Since we aren't providing any html documentation for any c++0x code at
>>> this time, maybe we should stop using html documentation? :P
>>> So the options are--
>>>  a) not document the c++0x code at all
>>>  b) write up documentation for all new code in html
>>>     to be consistent with what is used currently
>>>  c) move all existing documentation over to doxygen
>>>     before a single doxygen comment is added to the
>>>     new code
>> Assuming we want to have C++ 0x fully documented in 5.0 or shortly
>> thereafter which of (b) and (c) do you think is viable?
> I don't think any of those choice are viable _in the near term_ but if I 
> had to choose?
> C.  If only to get a better idea of how much work we're really talking 
> about.
> BTW, I'm still trying to figure out what it is that you are proposing 
> exactly.  :D

We have an established (albeit undocumented) process and
infrastructure for documenting code and publishing the
documentation. The onus is on you and Travis to come up
with a proposal if you want to change how things are done.

So far you've decided on your own, despite my objections
and without establishing consensus, to start adding Doxygen
style comments to new headers, without reconciling the
differences between the existing process and your new one,
and without providing a clear path to such a reconciliation
in the foreseeable future.

Unless these issues are satisfactorily resolved and until
there is a viable plan for producing a adequate replacement
for the existing class reference on a reasonable schedule
I have to insist that the Doxygen comments be removed from
the newly added headers.


View raw message