Re: [boost] [random] new documentation

Subject: Re: [boost] [random] new documentation
From: Rene Rivera (grafikrobot_at_[hidden])
Date: 2010-02-22 11:04:02

Joachim Faulhaber wrote:
> 2010/2/22 Steven Watanabe <watanabesj_at_[hidden]>
> 
>> AMDG
>>
>>
>> John Maddock wrote:
>>
>>> This is hopefully the final version of the work I did back in November
>>>> to convert the Random docs to Quickbook/Doxygen/Boostbook.
>>>> I've uploaded the generated documentation to
>>>> http://www.cs.hmc.edu/~swatanabe/random_doc/libs/random/doc/html/
>

>>>>
>>> Steven, I've only scanned those docs a little but this looks really good:
>>> much better than the old documentation!
>>>
>>> One thing I did notice were some very long lines in the reference section,
>>> for example:
>>> http://www.cs.hmc.edu/~swatanabe/random_doc/libs/random/doc/html/boost/taus88.html
>
>>>
>>> These are verging on the unreadable in HTML, but will just get truncated
>>> in PDF output :-(
>>>
>>> I suspect though that this is Doxygen mangling the formatting?
>>>
>> Yep.  You mentioned this before, but I couldn't find a way
>> to force it to be formatted properly.  The best I can think of
>> would be to get rid of the long type name and change it to
>> something like
>>
>> typedef xor_combine<...> taus88;
>>
>> for doxygen builds.
>>
>> I have the same problem in my reference section. E.g.
>
http://www.herold-faulhaber.de/boost_itl/doc/libs/itl/doc/html/boost/itl/interval_map.html
> 
> If someone knew a trick for a better formatting result, I'd be very
> interested.

Well the easy way would have been to change the wrapping with a 
"white-space: pre-wrap" CSS style. But, when I tried that, it produces 
rather bad rendering since those synopsis sections have white-space 
"columns". So to really fix things someone first has to change the doc 
generation to not use the rather bad white-space column format.

-- 
-- Grafik - Don't Assume Anything
-- Redshift Software, Inc. - http://redshift-software.com
-- rrivera/acm.org (msn) - grafik/redshift-software.com
-- 102708583/icq - grafikrobot/aim,yahoo,skype,efnet,gmail