Re: [ecf-dev] Linking to http://wiki.eclipse.org in Javadoc

["Mustafa K. Isik" <codesurgeon@xxxxxxxxx>]

Hi Markus,

On Feb 8, 2008, at 11:27 AM, Markus Alexande Kuppe wrote:
> [...]  what do people think about putting links to the Wiki in  
> Javadoc?

I think it is good practice when applied correctly.

> [...] I personally think the bigger picture is better documented on  
> the Wiki.

Sun's "How to Write Comments for the Javadoc Tool" at http://java.sun.com/j2se/javadoc/writingdoccomments/ 
 provides good guidelines for what to include in API Spec/Programming  
Guide code documentation and what to reference via external links.

See for instance the first paragraph under the headline "Writing  
Programming Guide Documentation" in the article.

+1

Cheers.

--
Mustafa K. Isik

http://codesurgeonblog.com