Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
RE: [eclipse-dev] API and javadoc

The concern here is with the Javadoc that we generate ourselves.

So in the Equinox case, only the API docs that appear in the Platform
Plug-in Developer Guide > Reference > API reference are interesting.

Wassim




                                                                           
             Thomas Watson                                                 
             <tjwatson@xxxxxx.                                             
             com>                                                       To 
             Sent by:                  "General development mailing list   
             eclipse-dev-bounc         of the Eclipse project."            
             es@xxxxxxxxxxx            <eclipse-dev@xxxxxxxxxxx>           
                                                                        cc 
                                                                           
             04/25/2007 09:26                                      Subject 
             AM                        RE: [eclipse-dev] API and javadoc   
                                                                           
                                                                           
             Please respond to                                             
                 "General                                                  
                development                                                
              mailing list of                                              
                the Eclipse                                                
                 project."                                                 
             <eclipse-dev@ecli                                             
                 pse.org>                                                  
                                                                           
                                                                           





In Equinox many bundles include packages specified by the OSGi Alliance
(all org.osgi.* packages).  For these packages the help contains a link to
the javadoc hosted by the OSGi Alliance at http://www2.osgi.org/javadoc/r4/


Should the same be done for any API shipped with the SDK which is not
defined or maintained by Eclipse?

Tom


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





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
_______________________________________________
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




Back to the top