[Laszlo-dev] Doc examples using CDATA

[Donald Anderson]

For anyone writing javadoc in .lzs files, here's a tip.
Live doc examples are not so hard to format using CDATA,
for example:
  /** My javadoc example:
    *
    * <example title="debug tag"><programlisting><![CDATA[
    * <canvas debug="true" height="120">
    *   <debug width="300" height="50" x="5" y="5" fontsize="8"/>
    *   <script>
    *   Debug.write("Hello world!");
    *   Debug.warn('This is a hotlink: %w', {a: 1, b: 2});
    *   </script>
    * </canvas>]]>
    * </programlisting></example>
    */

As long as your example doesn't contain a ']', I think anything
in the CDATA clause is taken verbatim, except that it strips out
the leading '*', just as you would want.  It really beats writing
(and reading) these using &lt;tag&gt;

I think most/all of the current examples do it the painful way -
I don't plan to change them, but just wanted to let you all know about  
this
for future.

- Don

--

Don Anderson
Java/C/C++, Berkeley DB, systems consultant

voice: 617-547-7881
email: [EMAIL PROTECTED]
www: http://www.ddanderson.com