Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r84696 - trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk
From: barend.gehrels_at_[hidden]
Date: 2013-06-08 13:43:48


Author: barendgehrels
Date: 2013-06-08 13:43:48 EDT (Sat, 08 Jun 2013)
New Revision: 84696
URL: http://svn.boost.org/trac/boost/changeset/84696

Log:
[geometry] added warning for template parameters without a type (which is usually an error in the docs)

Text files modified:
   trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/quickbook_output.hpp | 12 +++++++++---
   1 files changed, 9 insertions(+), 3 deletions(-)

Modified: trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/quickbook_output.hpp
==============================================================================
--- trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/quickbook_output.hpp Sat Jun 8 13:36:38 2013 (r84695)
+++ trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/quickbook_output.hpp 2013-06-08 13:43:48 EDT (Sat, 08 Jun 2013) (r84696)
@@ -59,7 +59,9 @@
 
 
 
-void quickbook_template_parameter_list(std::vector<parameter> const& parameters, std::ostream& out)
+void quickbook_template_parameter_list(std::vector<parameter> const& parameters,
+ std::string const& related_name,
+ std::ostream& out)
 {
     if (!parameters.empty())
     {
@@ -67,6 +69,10 @@
         bool first = true;
         BOOST_FOREACH(parameter const& p, parameters)
         {
+ if (p.fulltype.empty())
+ {
+ std::cerr << "Warning: template parameter " << p.name << " has no type in " << related_name << std::endl;
+ }
             out << (first ? "" : ", ") << p.fulltype;
             first = false;
         }
@@ -78,7 +84,7 @@
 void quickbook_synopsis(function const& f, std::ostream& out)
 {
     out << "``";
- quickbook_template_parameter_list(f.template_parameters, out);
+ quickbook_template_parameter_list(f.template_parameters, f.name, out);
 
     switch(f.type)
     {
@@ -516,7 +522,7 @@
     quickbook_markup(cos.qbk_markup, markup_before, markup_synopsis, out);
     out << "[heading Synopsis]" << std::endl
         << "``";
- quickbook_template_parameter_list(cos.template_parameters, out);
+ quickbook_template_parameter_list(cos.template_parameters, cos.name, out);
     out << (cos.is_class ? "class" : "struct")
         << " " << short_name << std::endl;
 


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk