I noticed there's a mix of using \a vs \p for parameters.

These actually don't do the same thing.
\p seems the better of the two.

\a seems to just make the arguments italic, and in the index
where all one liner description text is already italic, it makes
for really confusing reading; one can't tell arguments from normal text.
In the 'detailed description' section it's a little easier, but it's
still very subtle.

\p on the other hand seems to render in a different font size and font,
so it's quite a bit easier to see parameters mixed in with regular text.

It's *especially* noticeable when printed to hardcopy; I just ran
a printout of my docs, and noticed the \p items really stood out
nicely in both the index and detailed descriptions.

So I'm going to standardize on using \p in the Fl_Browser docs.
Most of the docs I've seen use \p, but some use \a (eg. Fl_x.cxx)
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev

Reply via email to