Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r83736 - trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk
From: barend.gehrels_at_[hidden]
Date: 2013-04-03 08:48:47


Author: barendgehrels
Date: 2013-04-03 08:48:46 EDT (Wed, 03 Apr 2013)
New Revision: 83736
URL: http://svn.boost.org/trac/boost/changeset/83736

Log:
[geometry] doxygen_xml2qbk added version to generated output, removed obsoelte qbk.skip mechaniscm, and small tweaks
Text files modified:
   trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp | 30 +++++++++++++++++++-----------
   trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml_parser.hpp | 13 +++----------
   2 files changed, 22 insertions(+), 21 deletions(-)

Modified: trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp
==============================================================================
--- trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp (original)
+++ trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp 2013-04-03 08:48:46 EDT (Wed, 03 Apr 2013)
@@ -1,6 +1,7 @@
 // doxml2qbk (developed in the context of Boost.Geometry documentation)
 //
-// Copyright (c) 2010-2012 Barend Gehrels, Amsterdam, the Netherlands.
+// Copyright (c) 2010-2013 Barend Gehrels, Amsterdam, the Netherlands.
+// Copyright (c) 2012-2013 Adam Wulkiewicz, Lodz, Poland.
 // Use, modification and distribution is subject to the Boost Software License,
 // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
 // http://www.boost.org/LICENSE_1_0.txt)
@@ -18,8 +19,6 @@
 // to an example.
 // - currently still in draft
 
-// Aug 14/15: added classes, defines, various enhancements.
-
 #include <iostream>
 #include <fstream>
 #include <sstream>
@@ -45,11 +44,19 @@
 
 static const std::string version = "1.1.0";
 
-inline std::string program_description()
+inline std::string program_description(bool decorated)
 {
- std::string result("=== doxygen_xml2qbk ");
+ std::string result;
+ if (decorated)
+ {
+ result = "=== ";
+ }
+ result += "doxygen_xml2qbk ";
     result += version;
- result += " ===";
+ if (decorated)
+ {
+ result += " ===";
+ }
     return result;
 }
 
@@ -82,12 +89,12 @@
                 ("convenience_headers", po::value<std::string>(&convenience_headers),
                             "Convenience header(s) (comma-separated)")
                 ("skip_namespace", po::value<std::string>(&config.skip_namespace),
- "Namespace to skip (e.g. boost::mylib::")
+ "Namespace to skip (e.g. boost::mylib::)")
                 ("copyright", po::value<std::string>(&copyright_filename),
                             "Name of QBK file including (commented) copyright and license")
 
                 ("output_style", po::value<std::string>(&output_style),
- "Docbook output style. Value:'alt'")
+ "Docbook output style. Available values: 'alt'")
             ;
 
             po::variables_map varmap;
@@ -113,14 +120,15 @@
             else if (varmap.count("help"))
             {
                 std::cout
- << program_description() << std::endl
+ << program_description(true) << std::endl
+ << "Available options:" << std::endl
                     << description << std::endl;
                 return 0;
             }
             else if (filename.empty())
             {
                 std::cout
- << program_description() << std::endl
+ << program_description(true) << std::endl
                     << "Allowed options:" << std::endl
                     << description << std::endl;
                 return 1;
@@ -178,7 +186,7 @@
 
         // Write warning comment
         std::cout
- << "[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]" << std::endl
+ << "[/ Generated by " << program_description(false) << ", don't change, will be overwritten automatically]" << std::endl
             << "[/ Generated from " << filename << "]" << std::endl;
 
         if ( configuration::def == config.output_style )

Modified: trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml_parser.hpp
==============================================================================
--- trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml_parser.hpp (original)
+++ trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml_parser.hpp 2013-04-03 08:48:46 EDT (Wed, 03 Apr 2013)
@@ -1,6 +1,7 @@
 // Boost.Geometry (aka GGL, Generic Geometry Library)
 //
-// Copyright (c) 2010-2012 Barend Gehrels, Amsterdam, the Netherlands.
+// Copyright (c) 2010-2013 Barend Gehrels, Amsterdam, the Netherlands.
+// Copyright (c) 2012-2013 Adam Wulkiewicz, Lodz, Poland.
 // Use, modification and distribution is subject to the Boost Software License,
 // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
 // http://www.boost.org/LICENSE_1_0.txt)
@@ -79,15 +80,7 @@
         {
             //std::cout << "ELEMENT: " << node->name() << "=" << node->value() << std::endl;
             std::string name = node->name();
- if (boost::equals(name, "qbk.skip"))
- {
- // TODO: this qbk.skip condition can be removed. It is not used anymore.
- // Then the skip parameter is also redundant.
- // Can be done after merging with the doxygen_xml2qbk version for Spatial.Index
- skip = true;
- return;
- }
- else if ( boost::equals(name, "itemizedlist") )
+ if ( boost::equals(name, "itemizedlist") )
             {
                 contents += "\n\n";
                 parse_para(node->first_node(), config, contents, skip, true, tb);


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