RE: [eclipse-dev] API and javadoc

[Wassim Melhem <wassimm@xxxxxxxxxx>]

Hi Walter,

Take a look at the JDT Plug-in Developer Guide > Reference > APT API
Reference sections.

The API docs listed there should be bound to their originating plug-in(s),
so that developers are able to navigate from source code to external
Javadoc.

The org.eclipse.pde.core.javadoc is the mechanism that maps a plug-in code
to its (otherwise seemingly random) javadoc location.

Anything else, including the javax.* packages you are referring to, is not
included.

Wassim





                                                                           
             "Walter Harley"                                               
             <wharley@xxxxxxx>                                             
             Sent by:                                                   To 
             eclipse-dev-bounc         "General development mailing list   
             es@xxxxxxxxxxx            of the Eclipse project."            
                                       <eclipse-dev@xxxxxxxxxxx>           
                                                                        cc 
             04/25/2007 01:10                                              
             AM                                                    Subject 
                                       RE: [eclipse-dev] API and javadoc   
                                                                           
             Please respond to                                             
                 "General                                                  
                development                                                
              mailing list of                                              
                the Eclipse                                                
                 project."                                                 
             <eclipse-dev@ecli                                             
                 pse.org>                                                  
                                                                           
                                                                           




Thanks, Wassim!

For the APT JSR-269 plugins that were added in 3.3, the only API is in
javax.*, that is, we contribute implementations of existing Java
language interfaces defined by Sun.  Do we need to do anything?

  -walter


-----Original Message-----
From: eclipse-dev-bounces@xxxxxxxxxxx
[mailto:eclipse-dev-bounces@xxxxxxxxxxx] On Behalf Of Wassim Melhem
Sent: Tuesday, April 24, 2007 7:19 PM
To: eclipse-dev@xxxxxxxxxxx
Subject: [eclipse-dev] API and javadoc


During the 3.3 cycle, 27 new plug-ins were added to the SDK, many of
which contribute new API.

Please make sure that any and every plug-in that contributes API is
accounted for in a org.eclipse.pde.core.javadoc extension in one of the
documentation plug-ins.

Platform plug-ins:  org.eclipse.platform.doc.isv JDT plug-ins:
org.eclipse.jdt.doc.isv PDE plug-ins: org.eclipse.pde.doc.user

If your new plug-in does not contribute API, no action is required.

Thanks,
Wassim

_______________________________________________
eclipse-dev mailing list
eclipse-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe
from this list, visit
https://dev.eclipse.org/mailman/listinfo/eclipse-dev

Notice:  This email message, together with any attachments, may contain
information  of  BEA Systems,  Inc.,  its subsidiaries  and  affiliated
entities,  that may be confidential,  proprietary,  copyrighted  and/or
legally privileged, and is intended solely for the use of the individual or
entity named in this message. If you are not the intended recipient, and
have received this message in error, please immediately return this by
email and then delete it.
_______________________________________________
eclipse-dev mailing list
eclipse-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe
from this list, visit
https://dev.eclipse.org/mailman/listinfo/eclipse-dev