Re: [Boost-docs] some doc nits

Subject: Re: [Boost-docs] some doc nits
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2010-06-12 17:42:03

> -----Original Message-----
> From: boost-docs-bounces_at_[hidden] [mailto:boost-docs-bounces_at_[hidden]] On Behalf Of Eric Niebler
> Sent: Saturday, June 12, 2010 6:59 AM
> To: Discussion of Boost Documentation
> Subject: [Boost-docs] some doc nits
> 
> On 6/12/2010 1:56 AM, Eric Niebler wrote:
> > My messages to this list are bouncing for some reason.
> 
> Wow, strange. OK, here's the original:
> 
> Just some doc nits, for anyone with the time, interest and xslt chops.
> 
> There's a problem with how the xslt is dealing with <purpose> elements
> for classes. See the synopsis I just generated for a class with two
> nested classes:
> 
> http://boost-sandbox.sourceforge.net/libs/proto/doc/html/boost/proto/domain.html
> 
> There's a lot that has gone wrong here. It seems whitespace matters when
> it probably shouldn't. Lines aren't broken sensibly, and when they are,
> they aren't preceded by // to indicate they're a comment. Perhaps this
> is my bad for writing a <purpose> that doesn't fit on one line, but that
> doesn't seem like an unreasonable thing to do.
> 
> Also notice how some comments don't get syntax highlighted, like the 3
> occurrences of "// types" and "// public member functions".
> 
> And as I've pointed out before, code that started out as a
> <programlisting> (e.g. the Example in the description) doesn't get
> highlighted at all.

I also note that the Doxygen reference syntax coloring is similarly wrong in my example in the html version - but
differently wrong with the pdf!

"// public member functions" is in keyword blue, not green/blue and some functions names are also blue instead of black.
 
I'll investigate this more in two weeks time when I'm refreshed by a holiday :-)

Paul