Re: [boost] Ordering the header files in the library's doxygen reference

Subject: Re: [boost] Ordering the header files in the library's doxygen reference
From: Edward Diener (eldiener_at_[hidden])
Date: 2016-04-21 14:17:13

On 4/21/2016 10:08 AM, Paul A. Bristow wrote:
>
>
>> -----Original Message-----
>> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Edward Diener
>> Sent: 13 April 2016 19:41
>> To: boost_at_[hidden]
>> Subject: [boost] Ordering the header files in the library's doxygen reference
>>
>> I use quickbook and doxygen to create the doc for my library. In my
>> jamfile for building the docs I have the header files in my doxygen
>> reference listed in the particular order I would like to see them in the
>> reference when the documentation is built. But for some reason I cannot
>> discern the order of the header files in the reference section of my
>> final HTML documentation is not the same as the order in which I have
>> the header files listed.
>>
>> Does anybody know how I can control the order of the header files listed
>> in the reference section of my library's HTML documentation ?
>
> I am unable to answer your question, but it is helpful to point out that
>
> 1  Using Quickbook code links to the header, functions, classes, member... you can make the order less important.
>
> 2  using Quickbook links you can lead the reader direct to the header under consideration.
>
> 3  Using Autoindex, you can make the order alphabetical, often what the user most wants (once he knows its name of course).
>
> But perhaps you know that and are still unsatisfied.

It's the order of the header files which shows in the reference section 
to the VMD library documentation which concerns me. The order is garbled 
from what I specify in my jamfile, which makes it much harder for an 
end-user to look in the reference section to find a VMD macro. This is 
occuring despite the fact that I specify the order which I want the 
header files to be listed in the reference section of the jamfile.

I do realize that I am probably negligent in providing all the necessary 
links in the actual Quickbook documentation which I should do to the 
reference file documentation. Still I think that when looking in the 
reference section directly the end-user should be presented with an 
alphabetical order of files which makes it easy to find something in 
particular.

I don't see the problem I am encountering with doxygen source file order 
in documentation for my tti library. I think it must have to do with 
doxygen being told that some of its input files are in sub-directories 
of a location where other input files are located.