On 6/1/07, Joel de Guzman <[EMAIL PROTECTED]> wrote:
> Matias Capeletto wrote:
>
> > Bimap Docs are now free of \n.
> > I recently translate Boost.Optional docs to qbk and in the reference,
> > fernando puts a small example for each function. If I do not used
> > __SPACE__ trick there the result is unreadable.
> > It is a good thing to banned the \n where possible but iI have find
> > places where I really need them.
>
> Could you show us a link of what you are talking about,
> with and without the __SPACE__ ? Perhaps that would give
> us a better understanding of the problem. png/gif snapshots
> plus actual html will be helpful. Also, please state the
> browser(s) you are using it with.

The new optional docs are in CVS (.qbk and html)
I am using firefox to take the following snapshots:

with out __SPACE__

http://matias.capeletto.googlepages.com/without_space.png

and with __SPACE__

http://matias.capeletto.googlepages.com/with_space.png

I think that the extra space really help here, and is part of
the formatting.

If you use code boxes for the functions definition the result is
even worst.

This is the only place where I have this problem.
Another option will be to standardize this kind of reference.
Boost.MultiIndex, Boost.Bimap and Boost.Optional to name
some libraries are using it.

Something like:

[function_reference
[function definition]
[requires .... ]                     [/optional]
[effects ... ]                        [/optional]
[complexity ... ]                  [/optional]
[exception_safety .... ]        [/optional]
[notes .... ]                          [/optional]
[example .... ]                    [/optional]
]

Best regards
Matias

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests: 
https://lists.sourceforge.net/lists/listinfo/boost-docs

Reply via email to