click-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Malcolm Edgar <malcolm.ed...@gmail.com>
Subject Re: new Javadoc 5 tags
Date Sun, 18 Oct 2009 09:29:20 GMT
That is great, will be much easier to write decent Javadoc.
regards Malcolm Edgar

On Sun, Oct 18, 2009 at 5:38 PM, Bob Schellink <sabob1@gmail.com> wrote:

> Javadoc 5 introduced the {@code} [1] tag which does not interpret HTML
> tags. Thus theres no need for escaping HTML entities. We can change code
> form this:
>
> <pre class="prettyprint">
>  &lt;context-param&gt;
>   &lt;param-name&gt;config-service-class&lt;/param-name&gt;
>   &lt;param-value&gt;com.corp.CustomConfigSerivce&lt;/param-value&gt;
>  &lt;/context-param&gt;
> </pre>
>
> to this:
>
> <pre class="prettyprint">
> {@code
>  <context-param>
>   <param-name>config-service-class</param-name>
>   <param-value>com.corp.CustomConfigSerivce</param-value>
>  </context-param>
> }
> </pre>
>
> Its also possible to close and reopen {@code} tags if HTML interpretation
> is needed:
>
> <pre class="prettyprint">
> {@code
>  <context-param>
>   <param-name>}<span class="red">config-service-class</font>{@code
> </param-name>
>   <param-value>com.corp.CustomConfigSerivce</param-value>
>  </context-param>
> }
> </pre>
>
> Nice!
>
> [1]:
> http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#{@code}<http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#%7B@code%7D>
>

Mime
View raw message