Re: [Boost-docs] Building doc with doxygen and quickbook problem

Subject: Re: [Boost-docs] Building doc with doxygen and quickbook problem
From: Edward Diener (eldiener_at_[hidden])
Date: 2010-10-08 14:05:52

On 10/7/2010 10:51 AM, Daniel James wrote:
> On 7 October 2010 14:10, Edward Diener<eldiener_at_[hidden]>  wrote:
>> I am building documentation using doxygen and quickbook. There is no problem
>> doing that except that my reference section, based on doxygen output, looks
>> wrong in the TOC. What I am seeing is:
>>
>> Reference
>>     Reference
>>         Header<boost/variadic_macro_data/VariadicMacroData.hpp>
>>
>> instead of:
>>
>> Reference
>>     Variadic Macro Data Reference
>
> You've probably put your 'xinclude' quickbook tag inside a quickbook
> section.

Yes, I have.

> You don't need to do that, the reference documentation
> defines a section itself.

Where is this documented ? How do I specify in quickbook where the 
Reference section goes ?

>
>> 2) My doxygen xml has an opening<library-reference>  while the unit has an
>> opening<library-reference id="units_reference">.
>>
>> 3) My doxygen xml has not<title>  after the<library-reference>  element but
>> the units one does have a<title>.
>
> Both of these are because it uses the '<reftitle>' feature in its
> build file. I think you can use something like:
>
>      doxygen target
>          : headers.hpp
>          :<reftitle>"My reference"
>          ;

OK, I did add a <reftitle>"Variadic Macro Data Reference" to my doxygen 
target and I can now see:

Reference
     Variadic Macro Data Reference
         Header <boost/variadic_macro_data/VariadicMacroData.hpp>

But I still have:

[section:vmd_reference Reference]
[xinclude VariadicMacroDataReference.xml]
[endsect]

I can remove this section, but I still need some way to order the 
reference section, whatever it is called, among my other quickbook sections.

>
> The id is automatically generated from the title. You can override it
> by using the 'boost.doxygen.refid' xsl parameter - although it looks
> like that only works if you've set a title. Probably wouldn't be too
> hard to change that.

Thanks for this info.