[email protected] wrote:
> Author: engelsman
> Date: 2008-10-08 15:04:13 -0700 (Wed, 08 Oct 2008)
> New Revision: 6399
> Log:
> completed addition of \section, \subsection and \par to drawing.dox
> 
> consistent \section, \subsection, \par applied to complete file.
> corresponding source code comments for functions still to be completed.

Good work!
Looks pretty good, the indentation with \par is nice :-)

If this works with LaTeX / pdf, then I would vote for this.

I'm very short in time today, therefore only one remark: The section 
names are global (you can refer to them from everywhere), thus we should 
use names that can easily be made unique. I proposed and started with 
using the filename part (without .dox) and an underline as a prefix to 
make things unique.

Before you (or anybody else) start/s more work, we should decide how to 
name the sections, because otherwise, we would get difficulties to get 
them unique over all files.

> -<h3><A name="lines">
> -Line Dashes and Thickness
> -</a></h3>
> +<A name="lines"></A> <!-- For old HTML links only ! -->
> +\subsection ssect_Lines Line Dashes and Thickness

In this case, this could be drawing_ssect_Lines, but IMHO "ssect_" would 
be redundant and could be omitted, or replaced by the section name.

A short rule could be: If you convert the HTML anchors to new doxygen 
\section, \subsection, or \subsubsection, use the filename part + an 
underscore + the previous anchor name, and we should be unique, and 
transforming the referring links would be easy.

Does this sound reasonable?

One more to html link formatting: *if* we want to make the html links 
*look* like doxygen links, we could add class="el" to the html code. I 
did this in a few cases in index.dox, and in the navigation links, where 
I had to use html.

And the last: Instead of \ref you can also use \link <ref> Any Link Text 
\endlink, if you want to "rename" the link, .e.g.

\link ssect_Complex more info here \endlink

This _should_ work, but it didn't when I tried it in my working copy, 
I'll have to look into that later :-( FWIW: It works with the navigation 
links.

Albrecht
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev

Reply via email to