CODEWITHSUNDEEP
javajavadoc
mcfly soft
mcfly soft

Reputation: 11645

How to write tags in a Javadoc

I would like to comment an example tag syntax in a javadoc. But Javadoc doesn't display Tags in its comment. Is it possible to do this ?

Sample: the svg tag comment is not displayed, because javadoc interpretes the tags not as comment.

/**
 * 
 * @param sMapData contains tags like the following sample : <br>
 * <svg><text color="000000" dates="-626,100;-545,100" fontsize="8" fs="normal" id="text31757_i1a" opa="1" text="L y d i a n" x="2915.5793" y="1889.9111"/></svg>
 * @return
 */

Upvotes: 2

Views: 145

Answers (1)

jensgram
jensgram

Reputation: 31508

According to this answer to Multiple line code example in Javadoc comment you can use {@code } wrapped in <pre></pre>:

/**
 * 
 * @param sMapData contains tags like the following sample:
 * 
 * <pre>
 * {@code
 * <svg>
 *   <text color="000000" dates="-626,100;-545,100" fontsize="8" fs="normal" id="text31757_i1a" opa="1" text="L y d i a n" x="2915.5793" y="1889.9111"/>
 * </svg>
 * }
 * </pre>
 * @return
 */

Upvotes: 2

Related Questions