[ROOT] Changes to THtml's documentation syntax

From: Axel Naumann (axel-naumann@gmx.de)
Date: Thu Sep 04 2003 - 00:05:37 MEST


Hi,

info for people writing documentation for their code:

since yesterday THtml has the following format for documentation:

// documentation in <pre> context (as before)
//BEGIN_HTML <!--
/* -->
plain html, without <pre> context
<!--*/
// -->END_HTML
// documentation continued, in <pre> context

Beware of the fact that for BEGIN_HTML/END_HTML blocks there is _no_ <pre>
anymore. This will need an update of your source file if you have </pre>
tags within BEGIN/END_HTML blocks. Note how to properly hide the frequent
/* */ inside BEGIN/END_HTML blocks.

The root documentation should reflect these changes; if you see a broken
doc page (esp. with <pre> all over) please post a message here.

This change was necessary to protect the average user from writing
something like this
// doc with image
//BEGIN_HTML
/*<img src="..." alt="...">
*/
//END_HTML
which produces invalid html output (<img> inside <pre>):
<pre>doc with image
/*<img src="..." alt="...">*/
</pre>

Axel.
PS: the web board is SO nice, and makes posts so much more readable - this
is going to be my last non-reply posting to roottalk.



This archive was generated by hypermail 2b29 : Thu Jan 01 2004 - 17:50:15 MET