Christopher Lenz wrote:

Nick Chalko wrote:

Erik Hatcher wrote:

On Sunday, January 5, 2003, at 04:57  PM, Nick Chalko wrote:

Why not  * @antdoc.example  snippet="<foo />"
*                               description="Generates a default bar"
         Lets keep as much as possible in the the source file.


Because its a real pain to HTML encode all the <> symbols and its much easier to have an external file with samples clearly formatted and styled in HTML I believe.



Won't xodlet handle the xml excaping for us. If not we should patch xdoclet.


Even if, you don't *really* want to put large (read: anything larger then <foo/>), multi-line examples in the attribute of an XDoclet tag, do you?

Specifying links to external examples that get merged in in the generation process sounds much more reasonable to me.

Hmm, it does make the java doc really long. As long as we encourage semantic markup in the "external" files. for example
<antdocs>
<example>
<usage>|<![CDATA[| <foo /> |]]>| </usage>
<description>|<![CDATA[| some <b>valid</b> xhtml.|]]></descriptoin>|
</example>
</antdocs>




--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>



Reply via email to