[
Date Prev][
Date Next][
Thread Prev][
Thread Next][
Date Index][
Thread Index]
[
List Home]
|
Re: [platform-doc-dev] javadoc problems (cut #1)
|
Thanks Nick. I fixed and released JavaCore.
Jerome
|---------+---------------------------------->
| | Nick |
| | Edgar/Ottawa/IBM@IBMCA |
| | Sent by: |
| | platform-doc-dev-admin@|
| | eclipse.org |
| | |
| | |
| | 03/27/2003 05:07 AM |
| | Please respond to |
| | platform-doc-dev |
| | |
|---------+---------------------------------->
>------------------------------------------------------------------------------------------------------------------------|
| |
| To: platform-doc-dev@xxxxxxxxxxx |
| cc: |
| Subject: Re: [platform-doc-dev] javadoc problems (cut #1) |
| |
>------------------------------------------------------------------------------------------------------------------------|
For JavaCore, it looks like the problem is with newSourceEntry(IPath,
IPath[], IPath). Its first sentence's first period is in an "i.e.". The
Javadoc summary for this method is truncated there.
Nick
Jim des Rivieres/Ottawa/IBM@IBMCA
Sent by: platform-doc-dev-admin@xxxxxxxxxxx
03/26/2003 07:30 PM
Please respond to platform-doc-dev
To: platform-doc-dev@xxxxxxxxxxx
cc:
Subject: Re: [platform-doc-dev] javadoc problems (cut #1)
I've released fixes for these Javadoc problems in Java Core:
- IJavaModel
- JavaConventions
- NamingConventions
- IJavaSearchConstants
- IWorkingCopy
I was unable to find anything really wrong with JavaCore. John: Do you
have a line number?
John Wiegand/Minneapolis/IBM@IBMUS
Sent by: platform-doc-dev-admin@xxxxxxxxxxx
03/26/2003 05:52 PM
Please respond to platform-doc-dev
To: platform-doc-dev@xxxxxxxxxxx
cc:
Subject: [platform-doc-dev] javadoc problems (cut #1)
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
_______________________________________________
platform-doc-dev mailing list
platform-doc-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-doc-dev
_______________________________________________
platform-doc-dev mailing list
platform-doc-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-doc-dev
