Re: [Boost-bugs] [Boost C++ Libraries] #3707: doxygen commands have a typo in tests \detailed should be \details

Subject: Re: [Boost-bugs] [Boost C++ Libraries] #3707: doxygen commands have a typo in tests \detailed should be \details
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2009-12-07 18:13:00

#3707: doxygen commands have a typo in tests \detailed should be \details
---------------------------+------------------------------------------------
 Reporter:  pbristow       |       Owner:  matthiasschabel
     Type:  Bugs           |      Status:  new            
Milestone:  Boost 1.42.0   |   Component:  units          
  Version:  Boost 1.41.0   |    Severity:  Cosmetic       
 Keywords:  doxygen units  |  
---------------------------+------------------------------------------------

Comment(by pbristow):

 Replying to [comment:3 steven_watanabe]:
 > Replying to [ticket:3707 pbristow]:
 > > Generating file member index...
 > > .cpp:11: Warning: Found unknown command `\detailed'
 > > I:/boost_1_41_0/libs/units/test/fail_quantity_assign.cpp:11:
 > >
 > > <snip 56 others>
 > >
 > > I:/boost_1_41_0/boost/units/dim.hpp:37: Warning: Found unknown command
 `\detailed'
 > >
 > > Copy and paste is wonderful but ... ;-)
 > >
 > > And a global grep to libs and boost unit replacing \detailed by
 \details gets rid of all these complaints.  (There are a few others that I
 will investigate).
 >
 > It would be better to remove it entirely because it is redundant.
 \details isn't available in doxygen 1.5 (which I am still using because
 somehow on my machine doxygen 1.6 was generating PNGs that IE8 couldn't
 display).

 I recall using \details in 1.5 but I could be having a(other) senior
 moment ;-)
 But detailed comments can be really useful - provided there are some, of
 course.

 (Aside: I am using Doxygen 1.6.1 without any problems - 1.6.0 crashed -
 and Dmitri van Heesch seems responsive to bug reports).

 The other 'fixes' to warnings seem ill-advised, but I'd be happier with
 \detailed changed to \details, if applicable - and I'd be delighted if it
 applied long-term.

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/3707#comment:5>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.