RE: [Doxygen-users] Re: files order

[Stephen G. <ste...@cl...>]

Replying to my own message:

> -----Original Message-----
> From: dox...@li...
> [mailto:dox...@li...]On Behalf Of Stephen
> Goudge
> Sent: 05 June 2001 09:43
> To: dox...@li...
> Subject: [Doxygen-users] Re: files order
> 
> 
> It is true that the HTML output can be accessed in any order, 
> but it can still
> be useful to have a 'natural reading order'. It is an advantage of any
> hyper-linked document that you can leap around, but you still 
> benefit from being
> able to refer back to a structured overview.
<snip>

looking through some archived messages, I thought this was worth re-posting:

> -----Original Message-----
> From: Jani Kajala [mailto:jan...@re...]
> Sent: 17 November 2000 09:05
> To: Doxygen Mailing List
> Subject: Structuring documentation
> 
> 
> Hi all,
> 
> How can I define the structure of the documentation with Doxygen?
> 
> So far I've only managed to produce individual pages and link 
> them \refs. This is fine for HTML but not for more book-like 
> output formats (like for example RTF). So what I'm seeking 
> for is a way to write hierarchical (Chapter 1, Chapter 1.1, 
> ...) manual (with class documentation and individual pages 
> 'inserted' to it). But I just can't find a way how to define 
> relative order of pages and the documentation structure in general.
> 
> Hope this example clarifies a bit:
> 
> SDK Documentation
>     +- What's New
>     |   |- Legal Information
>     |   |- Release Notes
>     |   \- About SDK
>     |
>     +- Used Conventions
>     +- Reference Manual
>     |   +- About Reference Manual
>     |   +- Class Reference
>     |        +- Class A
>     |        +- Class B
>     +- ...
> 
> Hope somebody can help. I haven't used Doxygen that much yet, 
> but I've liked many features so far (for example convenient 
> \ref, \b, \c etc. tags are really nice). I do have used a lot 
> of documentation generators before though, Doc++, CCDoc, 
> JavaDoc, Object Outline, ...
> 
> 
> Regards,
> Jani Kajala