[Boost-docs] Re: Questions about QuickBook-Doxygen and cpp inclusion

[Freedamzk]

It's always a good idea to provide a (minimal) test case that
we can try. Otherwise, it will be difficult to find an answer.

Here I attach 3 files: a dummy.qbk file, a Jamfile.v2 to build the 
documentation and a dummy_classes.hpp header file.

Copy 3 files to $(BOOST_ROOT)/libs/quickbook-doxygen-error/ and generate 
documentation via:

$ quickbook dummy.qbk
$ bjam --v2

It will create a html folder with index.html being the doxygen 
reference. In the header file class dummy_class is declared inside 
boost::dummy_namespace namespace and the class extern_dummy_class is 
declared in the global scope. The reference will generate just one 
description for extern_dummy_class but two for dummy_class (one inside 
boost::dummy_namespace and another one in the global scope).

If you need more data, please let me know,

Cheers,

Ion

import boostbook : boostbook ;
using quickbook ;
import doxygen : doxygen ;

boostbook dummy
:
   dummy.xml
   dummy.doxygen
:
   <xsl:param>boost.root=../../../..
;

doxygen dummy.doxygen
:
   [ glob dummy_classes.hpp ]
;

[library Dummy
    [version 2005-09-18]
    [authors [Gazta&ntilde;aga, Ion]]
    [copyright 2005 Ion Gazta&ntilde;aga]
    [purpose Shared memory utilities]
    [license
         Distributed under the Boost Software License, Version 1.0.
         (See accompanying file LICENSE_1_0.txt or copy at
         <ulink url="http://www.boost.org/LICENSE_1_0.txt";>
            http://www.boost.org/LICENSE_1_0.txt
         </ulink>)
    ]
    [last-revision $Date: 2005/09/18 00:00:00 $]
]

[/ QuickBook Document version 1.1 ]

[xinclude dummy.doxygen.boostbook]

#ifndef _DUMMY_CLASSES_HPP_
#define _DUMMY_CLASSES_HPP_

namespace boost
{
namespace dummy_namespace
{

/*!Dummy class*/
class dummy_class
{
   /*!dummy_func() function*/
   void dummy_func();
};

}
}

/*!Dummy class*/
class extern_dummy_class
{
   /*!dummy_func() function*/
   void extern_dummy_func();
};

#endif