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-03 15:19:03

#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):

 Also line 15 test_lambda.cpp

 /// \file test_lambda.hpp should be .cpp

 Doxygen comments are wrong in boost/units/physical_dimensions.hpp

 /// \file physical_dimensions.hpp
 ///
 /// \brief Physical dimensions according to the SI system
 ///
 /// \details This header includes all physical dimension headers for both
 base
 /// derived dimensions. Base dimensions are extended to include plane and
 /// solid angle for convenience.

 doxygen would like a ; at the end of

     BOOST_TYPEOF_NESTED_TYPEDEF_TPL(nested, pow(typeof_::make<Y>(), 0.0));

 in static_rational_power.hpp

 and boost\libs\units\test\test_output.cpp

 \file test_output..cpp

 was missing the filename.

 Finally Doxygen warns:

 I:/boost_trunk/libs/units/test/test_output.cpp:91: Warning: no matching
 file member found for
 const char * name_string(const boost::units::reduce_unit<
 boost::units::unit< boost::units::acceleration_dimension, my_system >
 >::type &)
 Possible candidates:
   std::string name_string(const cgs::force &)
   std::string name_string(const custom1 &)
   std::string name_string(const unit< Dimension, System > &)
   std::string name_string(const scale< Base, Exponent > &)
   std::string name_string(const reduce_unit< cgs::acceleration >::type &)
   std::string name_string(const T &)
 I:/boost_trunk/libs/units/test/test_output.cpp:92: Warning: no matching
 file member found for
 const char * symbol_string(const boost::units::reduce_unit<
 boost::units::unit< boost::units::acceleration_dimension, my_system >
 >::type &)
 Possible candidates:
   std::string symbol_string(const cgs::force &)
   std::string symbol_string(const custom1 &)
   std::string symbol_string(const unit< Dimension, System > &)
   std::string symbol_string(const scale< Base, Exponent > &)
   std::string symbol_string(const reduce_unit< cgs::acceleration >::type
 &)
   std::string symbol_string(const T &)

 It would seem that custom2 is not used?  With it commented out (and other
 changes above corrected) Doxygen builds with no warnings.

 I am finding a full Doxygen build a useful addition to the already helpful
 but still, for me, insufficient documentation for this massive package.
 If the files and parameters were documented (a massive task) it would be
 even better.  A GSoC project?

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