Does Javadoc have an equivalent to <![CDATA[ ... ]]>?

java html xml javadoc cdata
13ren picture 13ren · Nov 23, 2009 · Viewed 6.9k times · Source

Unfortunately, there is no CDATA in HTML.

This is a pity, because it would be perfect for adding javadoc comments that include XML, so you don't have to escape the < and >, for example:

/**<![CDATA[ This parses <complexType name=""> ]]>*/

However, it would be possible for javadoc to recognize the CDATA section, and convert it to HTML for you. For example:

This parses &lt;complexType name=""&gt;

Or it could use some simpler syntax than CDATA. Because javadoc is extensible, it's possible someone has added this functionality; or maybe javadoc already has it buried somewhere inside... Does anybody know?

Answer

Fabian Steeg picture Fabian Steeg · Nov 23, 2009

You can use JavaDoc's @code tag: /** This parses {@code <complexType name="">} */

Related questions

Convert html to xml using java

Can any one suggest me a best approach for converting html to xml using java Is there any API available for that? The html also might contain javascript code I have tried below code: import java.io.BufferedInputStream; import java.…

Read More
How do I make JTIdy make HTML documents well-formed?

I'm using JTidy v. r938. I'm using this code to attempt to clean up a page … final Tidy tidy = new Tidy(); tidy.setQuiet(false); tidy.setShowWarnings(true); tidy.setShowErrors(0); tidy.setMakeClean(true); Document document = tidy.parseDOM(conn.getInputStream(), null); But …

Read More
Why getChild() method of JDOM returns null?

I'm doing a project regarding html document manipulation. I want body content from existing html document to modify it into a new html.Now i'm using JDOM. i want to use body element in my coding.For that i used …

Read More