Re: doxygen + char_traits, patch

[Phil Edwards <pedwards at disaster dot jaj dot com>]

On Fri, Apr 27, 2001 at 04:57:15PM -0700, Benjamin Kosnik wrote:
> Ok. Can we either have the left-hand pane or the top pane, but not both?
> I don't really care which one bites it, but it would be nice if there was 
> only one. 

We don't have any direct control over the contents of the top pane, so to
speak; the list of "Compound List", "Class Hiearachy" and so forth are
essentially hardcoded.  I asked about this on the Doxygen mailing list,
and got a couple of "yeah, I'd like to be able to do that too" messages,
but nothing else.

Some will appear only when needed, e.g., if we only have one namespace,
then "Namespace List" vanishes.  That's doxygen's decision, though.

We /can/ turn them all off, and write our own header, but we cannot toggle
individual ones.

So okay, let's leave the left-hand pane dead.  It lets us work with people
who don't want to use Javascript, too.


> I checked in changes that generate a mainpage. Check it out and let me 
> know what you think.

Great.  I'd completely forgotten about \mainpage.


> EXTRACT_ALL            = YES

That's one of those things that I thought might someday be the difference
between "user" and "maintainer" documentation.  It starts pulling out all
the behind-the-scenes stuff as well.  We might use grouping for that, too,
if I ever have time to learn it.


> 1) make a specializations group, so that it was obvious that
> char_traits<_CharT>
> char_traits<char>
> char_traits<wchar_t>

Have to play with the grouping tags for this one, I think.


> 2) is there a way to "inline" the html generated by the "List of all 
> members" link? That would be most useful. I think the page would look better.

No idea.  Nothing stands out in the cfg file.  This may be yet another
hardcoded doxygen thing.


> 3) is there a way to remove the "Referenced by to_char_type()." bits for 
> every member function and typedef? Not especially useful, and takes up a 
> lot of space.

I can't see this one... which .cfg setting turns that on?


> 4) is there more typographic control over what is bold, what is 
> highlighted, etc?

Some.  We can use bold/italics/whatnot in the comments we add in the code,
e.g., I was using "@c pair" in the stl_pair.h header to make "pair" appear
as code, but the text generated by doxygen is only somewhat controlled by
the generated CSS stylesheet.

I think it can be pre-generated, edited and stored, and then used instead
of generating one.  I'll look into this shortly.


> 5) I'd like to get rid of 
> 
> Public Types
> 
> Static Public Method
> 
> bits since they are empty. Can't figure this out.

I think that's hardcoded in Doxygen.


I'm about to use doxygen's "-u" option to update our cfg file to the
current version.  I'll commit it in a bit.


Phil

-- 
pedwards at disaster dot jaj dot com  |  pme at sources dot redhat dot com
devphil at several other less interesting addresses in various dot domains
The gods do not protect fools.  Fools are protected by more capable fools.