Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [platform-doc-dev] javadoc problems (cut #1)

Fixed and released:

C:\source-eclipse0325\plugins\org.eclipse.platform.doc.isv\..
\org.eclipse.update.core\src\org\eclipse\update\core\IFeatureContentProvider

I couldn't find any 'suspect' pattern in

C:\source-eclipse0325\plugins\org.eclipse.platform.doc.isv\..
\org.eclipse.update.core\src\org\eclipse\update\core\SiteContentProvider
C:\source-eclipse0325\plugins\org.eclipse.platform.doc.isv\..
\org.eclipse.update.core\src\org\eclipse\update\core\ISiteContentProvider

can you confirm ?

Christophe Elek
Eclipse.org (Platform Update Core)
IBM Software Group - Cross Product Support
IBM Canada Ltd.

celek@xxxxxxxxxx
(905) 413-3467


                                                                           
             John                                                          
             Wiegand/Minneap                                               
             olis/IBM@IBMUS                                             To 
             Sent by:                   platform-doc-dev@xxxxxxxxxxx       
             platform-doc-de                                            cc 
             v-admin@eclipse                                               
             .org                                                      bcc 
                                                                           
                                                                   Subject 
             03/26/2003                 [platform-doc-dev] javadoc         
             05:52 PM                   problems (cut #1)                  
                                                                           
                                                                           
             Please respond                                                
                   to                                                      
             platform-doc-de                                               
                    v                                                      
                                                                           
                                                                           








We have several problems in the javadoc.  I am moving much more slowly than
I hoped, but here is the nature of the problem:

We have ill-formed summary statements for method and field javadoc.  The
summary is the text up to the first "."  The following
pattern occurs in several locations:

daksjlk (i.e. dfjasl) fdkjsal -- the problem here is the period after i.e.
The initial text must end in a "." that is followed by whitespace.

Here are the few locations that I have discovered already (I will collect
the full set tonight).  In addition, I will summarize the other javadoc
errors.
-----------------------------------------

C:\source-eclipse0325\plugins\org.eclipse.platform.doc.isv\..
\org.eclipse.compare\compare\org\eclipse\compare\IEditableContent

C:\source-eclipse0325\plugins\org.eclipse.platform.doc.isv\..
\org.eclipse.update.core\src\org\eclipse\update\core\SiteContentProvider
C:\source-eclipse0325\plugins\org.eclipse.platform.doc.isv\..
\org.eclipse.update.core\src\org\eclipse\update\core\ISiteContentProvider

C:\source-eclipse0325\plugins\org.eclipse.platform.doc.isv\..
\org.eclipse.update.core\src\org\eclipse\update\core\IFeatureContentProvider


C:\source-eclipse0325\plugins\org.eclipse.platform.doc.isv\..
\org.eclipse.jface.text\src\org\eclipse\jface\text\source\OverviewRuler.java


C:\source-eclipse0325\plugins\org.eclipse.platform.doc.isv\..
\org.eclipse.jface.text\src\org\eclipse\jface\text\source\IVerticalRulerExtension.java



C:\source-eclipse0325\plugins\org.eclipse.platform.doc.isv\..
\org.eclipse.ui.workbench\Eclipse
 UI\org\eclipse\ui\help\IContextComputer


C:\source-eclipse0325\plugins\org.eclipse.jdt.doc.isv\..
\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IJavaModel.java
C:\source-eclipse0325\plugins\org.eclipse.jdt.doc.isv\..
\org.eclipse.jdt.core\model\org\eclipse\jdt\core\JavaConventions.java

C:\source-eclipse0325\plugins\org.eclipse.jdt.doc.isv\..
\org.eclipse.jdt.core\model\org\eclipse\jdt\core\JavaCore.java

C:\source-eclipse0325\plugins\org.eclipse.jdt.doc.isv\..
\org.eclipse.jdt.core\model\org\eclipse\jdt\core\NamingConventions.java
      (here we have the pattern .<br> - this causes the summary to be
several lines instead of one.  I am not sure this was intentional)

_______________________________________________
platform-doc-dev mailing list
platform-doc-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-doc-dev




Back to the top