[Yanel-dev] Javadoc tips (was: Re: [Yanel-commits] rev 48215 - public/yanel/trunk/src/impl/java/org/wyona/yanel/impl/navigation)

[Mehmet Birgi]

thanks, i will keep that in mind in the future.


2010/3/23 Guillaume D=E9flache <guillaume.deflache at wyona.com>

> memo at wyona.com schrieb:
>
>> Author: memo
>> Date: 2010-03-22 16:51:38 +0100 (Mon, 22 Mar 2010)
>> New Revision: 48215
>>
>> Modified:
>>
>> public/yanel/trunk/src/impl/java/org/wyona/yanel/impl/navigation/Sitetre=
eDOMImpl.java
>> Log:
>> javadoc fixed
>>
>> Modified:
>> public/yanel/trunk/src/impl/java/org/wyona/yanel/impl/navigation/Sitetre=
eDOMImpl.java
>> =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
>> ---
>> public/yanel/trunk/src/impl/java/org/wyona/yanel/impl/navigation/Sitetre=
eDOMImpl.java
>>       2010-03-22 15:50:36 UTC (rev 48214)
>> +++
>> public/yanel/trunk/src/impl/java/org/wyona/yanel/impl/navigation/Sitetre=
eDOMImpl.java
>>       2010-03-22 15:51:38 UTC (rev 48215)
>> @@ -27,20 +27,25 @@
>>  import org.w3c.dom.NodeList;
>>  /**
>> - * Based on DOM, whereas persistance is done through the src
>> configuration, for example within realm.xml
>> - * <repo-navigation
>> class=3D"org.wyona.yanel.impl.navigation.SitetreeDOMImpl">
>> - *   <src>data-repo/data/sitetree.xml</src>
>> - * </repo-navigation>
>> + * Based on DOM, whereas persistance is done through the <code>src</cod=
e>
>> configuration, for example within <code>realm.xml</code>
>> + * <pre>
>> + * &lt;repo-navigation
>> class=3D"org.wyona.yanel.impl.navigation.SitetreeDOMImpl">
>> + *   &lt;src>data-repo/data/sitetree.xml&lt;/src>
>> + * &lt;/repo-navigation>
>> + * </pre>
>>
>
> Using <pre>{@code ...}</pre> (cf. <
> http://java.sun.com/javase/6/docs/technotes/tools/windows/javadoc.html#@c=
ode>)
> instead would allow to not escape the tags, making the whole thing more
> readable from the source code.
>
>
>   *
>> - * or .yanel-rc
>> + * or <code>.yanel-rc</code>
>>  *
>> - * <yanel:custom-config>
>> - *   <s:repo-navigation xmlns:s=3D"
>> http://www.wyona.org/yanel/sitetree-dom-impl/1.0"
>> class=3D"org.wyona.yanel.impl.navigation.SitetreeDOMImpl">
>> - *     <s:src>yanelrepo:/sitetree.xml</s:src>
>> - *   </s:repo-navigation>
>> - * </yanel:custom-config>
>> + * <pre>
>> + * &lt;yanel:custom-config>
>> + *   &lt;s:repo-navigation xmlns:s=3D"
>> http://www.wyona.org/yanel/sitetree-dom-impl/1.0"
>> class=3D"org.wyona.yanel.impl.navigation.SitetreeDOMImpl">
>> + *     &lt;s:src>yanelrepo:/sitetree.xml&lt;/s:src>
>> + *   &lt;/s:repo-navigation>
>> + * &lt;/yanel:custom-config>
>> + * </pre>
>>
>
> Ditto here.
>
>
>   *
>> - * Please note that the class org.wyona.yanel.core.map.Realm is using t=
he
>> RealmConfigPathResolver whereas that a resource might use a different
>> resolver implementation!
>> + * Please note that the class <code>org.wyona.yanel.core.map.Realm</cod=
e>
>> + * is using the <code>RealmConfigPathResolver</code> whereas that a
>> resource might use a different resolver implementation!
>>
>
> When one references a Java name for the 1st time, a link is even better,
> e.g.
> - {@link org.wyona.yanel.core.map.Realm}
> or
> - {@link org.wyona.yanel.core.map.RealmConfigPathResolver
> RealmConfigPathResolver}
> (cf. <
> http://java.sun.com/javase/6/docs/technotes/tools/windows/javadoc.html#@l=
ink
> >)
>
>  [...]
>>
> --
> Yanel-development mailing list Yanel-development at wyona.com
> http://lists.wyona.org/cgi-bin/mailman/listinfo/yanel-development
>



-- =

Mehmet Birgi
www.wyona.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.wyona.org/pipermail/yanel-development/attachments/2010032=
3/7de9d3f6/attachment-0001.htm