Attachment 10795 Details for Bug 62769 – Fix javadocs for API

Fix javadocs for API

javadoc_patch.txt (text/plain), 15.97 KB, created by Olivier Thomann

on 2004-05-18 15:48:05 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Olivier Thomann

Created: 2004-05-18 15:48:05 EDT

Size: 15.97 KB

patch

obsolete

>Index: dom/org/eclipse/jdt/core/dom/AST.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/AST.java,v
>retrieving revision 1.117
>diff -u -r1.117 AST.java
>--- dom/org/eclipse/jdt/core/dom/AST.java	30 Apr 2004 17:39:41 -0000	1.117
>+++ dom/org/eclipse/jdt/core/dom/AST.java	18 May 2004 19:33:07 -0000
>@@ -1016,7 +1016,7 @@
> 	/**
> 	 * Sets default node flags of new nodes of this AST.
> 	 * 
>-	 * @param default node flags of new nodes of this AST
>+	 * @param flag node flags of new nodes of this AST
> 	 * @since 3.0
> 	 */
> 	void setDefaultNodeFlag(int flag) {
>Index: dom/org/eclipse/jdt/core/dom/ASTNode.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTNode.java,v
>retrieving revision 1.59
>diff -u -r1.59 ASTNode.java
>--- dom/org/eclipse/jdt/core/dom/ASTNode.java	30 Apr 2004 15:00:56 -0000	1.59
>+++ dom/org/eclipse/jdt/core/dom/ASTNode.java	18 May 2004 19:33:09 -0000
>@@ -1530,7 +1530,6 @@
> 	 * </ul>
> 	 * 
> 	 * @param property the property
>-	 * @return the value, or <code>null</code> if none
> 	 * @exception RuntimeException if this node does not have the
> 	 * given property, or if the given property cannot be set
> 	 * @since 3.0
>Index: dom/org/eclipse/jdt/core/dom/ASTParser.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTParser.java,v
>retrieving revision 1.14
>diff -u -r1.14 ASTParser.java
>--- dom/org/eclipse/jdt/core/dom/ASTParser.java	23 Apr 2004 17:38:46 -0000	1.14
>+++ dom/org/eclipse/jdt/core/dom/ASTParser.java	18 May 2004 19:33:11 -0000
>@@ -51,7 +51,7 @@
> * <li>Source string from {@link #setSource(char[]) char[]},
> * {@link #setSource(ICompilationUnit) ICompilationUnit},
> * or {@link #setSource(IClassFile) IClassFile}, and limited
>- * to a specified {@linkplain #setSourceRange(int,int) subrange.</li>
>+ * to a specified {@linkplain #setSourceRange(int,int) subrange}.</li>
> * <li>Whether {@linkplain #setResolveBindings(boolean) bindings} will be created.</li>
> * <li>Which {@linkplain #setWorkingCopyOwner(WorkingCopyOwner)
> * working set owner} to use when resolving bindings).</li>
>Index: dom/org/eclipse/jdt/core/dom/ClassInstanceCreation.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ClassInstanceCreation.java,v
>retrieving revision 1.33
>diff -u -r1.33 ClassInstanceCreation.java
>--- dom/org/eclipse/jdt/core/dom/ClassInstanceCreation.java	27 Apr 2004 16:07:18 -0000	1.33
>+++ dom/org/eclipse/jdt/core/dom/ClassInstanceCreation.java	18 May 2004 19:33:11 -0000
>@@ -466,7 +466,7 @@
> 	 * Sets the type instantiated in this class instance creation
> 	 * expression (added in JLS3 API).
> 	 * 
>-	 * @param name the new type
>+	 * @param type the new type
> 	 * @exception IllegalArgumentException if:
> 	 * <ul>
> 	 * <li>the node belongs to a different AST</li>
>Index: dom/org/eclipse/jdt/core/dom/CompilationUnit.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/CompilationUnit.java,v
>retrieving revision 1.55
>diff -u -r1.55 CompilationUnit.java
>--- dom/org/eclipse/jdt/core/dom/CompilationUnit.java	27 Apr 2004 16:07:18 -0000	1.55
>+++ dom/org/eclipse/jdt/core/dom/CompilationUnit.java	18 May 2004 19:33:12 -0000
>@@ -381,7 +381,7 @@
> 	 * </ul>
> 	 * 
> 	 * 
>-	 * Each call to {@link ASTParser#createAST(IProgressMonitor)} with a request for bindings
>+	 * Each call to {@link ASTParser#createAST(org.eclipse.core.runtime.IProgressMonitor)} with a request for bindings
> 	 * gives rise to separate universe of binding objects. This method always returns
> 	 * <code>null</code> when the binding object comes from a different AST.
> 	 * Use <code>findDeclaringNode(binding.getKey())</code> when the binding comes
>@@ -837,7 +837,7 @@
> 	 * @param options the table of formatter options
> 	 * (key type: <code>String</code>; value type: <code>String</code>);
> 	 * or <code>null</code> to use the standard global options
>-	 * {@link JavaCore#getOptions() JavaCore.getOptions()}.
>+	 * {@link org.eclipse.jdt.core.JavaCore#getOptions() JavaCore.getOptions()}.
> 	 * @return text edit object describing the changes to the
> 	 * document corresponding to the recorded AST modifications
> 	 * @exception IllegalArgumentException if the document passed is
>Index: dom/org/eclipse/jdt/core/dom/StructuralPropertyDescriptor.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/StructuralPropertyDescriptor.java,v
>retrieving revision 1.1
>diff -u -r1.1 StructuralPropertyDescriptor.java
>--- dom/org/eclipse/jdt/core/dom/StructuralPropertyDescriptor.java	25 Feb 2004 06:30:16 -0000	1.1
>+++ dom/org/eclipse/jdt/core/dom/StructuralPropertyDescriptor.java	18 May 2004 19:33:12 -0000
>@@ -82,7 +82,7 @@
> 	
> 	/**
> 	 * Returns whether this property is a simple property
>-	 * (instance of {@link SimplePropertyDescriptor).
>+	 * (instance of {@link SimplePropertyDescriptor)}.
> 	 * 
> 	 * @return <code>true</code> if this is a simple property, and 
> 	 * <code>false</code> otherwise
>@@ -93,7 +93,7 @@
> 	
> 	/**
> 	 * Returns whether this property is a child property
>-	 * (instance of {@link ChildPropertyDescriptor).
>+	 * (instance of {@link ChildPropertyDescriptor)}.
> 	 * 
> 	 * @return <code>true</code> if this is a child property, and 
> 	 * <code>false</code> otherwise
>@@ -104,7 +104,7 @@
> 	
> 	/**
> 	 * Returns whether this property is a child list property
>-	 * (instance of {@link ChildListPropertyDescriptor).
>+	 * (instance of {@link ChildListPropertyDescriptor)}.
> 	 * 
> 	 * @return <code>true</code> if this is a child list property, and 
> 	 * <code>false</code> otherwise
>Index: model/org/eclipse/jdt/core/IClasspathContainer.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/model/org/eclipse/jdt/core/IClasspathContainer.java,v
>retrieving revision 1.17
>diff -u -r1.17 IClasspathContainer.java
>--- model/org/eclipse/jdt/core/IClasspathContainer.java	5 May 2004 15:05:48 -0000	1.17
>+++ model/org/eclipse/jdt/core/IClasspathContainer.java	18 May 2004 19:33:13 -0000
>@@ -78,13 +78,13 @@
> 	 * <ul>
> 	 * <li>{@link JavaCore#newLibraryEntry(IPath, IPath, IPath, boolean)} and variants</li>
> 	 * <li>{@link JavaCore#newProjectEntry(IPath, boolean)} and variants</li>
>-	 * <li>{@link JavaCore#create(IWorkspaceRoot)</li>
>-	 * <li>{@link JavaCore#create(IProject)</li>
>-	 * <li>{@link IJavaModel#getJavaProjects()</li>
>-	 * <li>{@link IJavaProject#getRawClasspath()</li>
>-	 * <li>{@link IJavaProject#readRawClasspath()</li>
>-	 * <li>{@link IJavaProject#getOutputLocation()</li>
>-	 * <li>{@link IJavaProject#readOutputLocation()</li>
>+	 * <li>{@link JavaCore#create(org.eclipse.core.resources.IWorkspaceRoot)}</li>
>+	 * <li>{@link JavaCore#create(org.eclipse.core.resources.IProject)}</li>
>+	 * <li>{@link IJavaModel#getJavaProjects()}</li>
>+	 * <li>{@link IJavaProject#getRawClasspath()}</li>
>+	 * <li>{@link IJavaProject#readRawClasspath()}</li>
>+	 * <li>{@link IJavaProject#getOutputLocation()}</li>
>+	 * <li>{@link IJavaProject#readOutputLocation()}</li>
> 	 * <li>Java element operations marked as "handle-only"</li>
> 	 * </ul>
> 	 * The effects of using other Java model APIs are unspecified.
>Index: model/org/eclipse/jdt/core/ICompilationUnit.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/model/org/eclipse/jdt/core/ICompilationUnit.java,v
>retrieving revision 1.47
>diff -u -r1.47 ICompilationUnit.java
>--- model/org/eclipse/jdt/core/ICompilationUnit.java	23 Apr 2004 17:38:46 -0000	1.47
>+++ model/org/eclipse/jdt/core/ICompilationUnit.java	18 May 2004 19:33:13 -0000
>@@ -518,7 +518,7 @@
> * 
> *
> * @param astLevel either {@link #NO_AST} if no AST is wanted,
>- * or the {@linkplain AST#AST(int) AST API level} of the AST if one is wanted
>+ * or the {@linkplain AST#newAST(int) AST API level} of the AST if one is wanted
> * @param forceProblemDetection boolean indicating whether problem should be 
> * recomputed even if the source hasn't changed
> * @param owner the owner of working copies that take precedence over the 
>Index: model/org/eclipse/jdt/core/Signature.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/model/org/eclipse/jdt/core/Signature.java,v
>retrieving revision 1.44
>diff -u -r1.44 Signature.java
>--- model/org/eclipse/jdt/core/Signature.java	12 Apr 2004 16:35:14 -0000	1.44
>+++ model/org/eclipse/jdt/core/Signature.java	18 May 2004 19:33:14 -0000
>@@ -445,7 +445,7 @@
> * @param parameterTypes the list of parameter type signatures
> * @param returnType the return type signature
> * @return the encoded method signature
>- * @see Signature#createMethodSignature(String[], String, String[], String[])
>+ * @see Signature#createMethodSignature(char[][], char[])
> */
> public static String createMethodSignature(String[] parameterTypes, String returnType) {
> 	int parameterTypesLenth = parameterTypes.length;
>Index: model/org/eclipse/jdt/core/eval/ICodeSnippetRequestor.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/model/org/eclipse/jdt/core/eval/ICodeSnippetRequestor.java,v
>retrieving revision 1.10
>diff -u -r1.10 ICodeSnippetRequestor.java
>--- model/org/eclipse/jdt/core/eval/ICodeSnippetRequestor.java	11 Feb 2004 16:06:59 -0000	1.10
>+++ model/org/eclipse/jdt/core/eval/ICodeSnippetRequestor.java	18 May 2004 19:33:15 -0000
>@@ -22,8 +22,8 @@
> * Clients may implement this interface to provide a bridge a running Java VM.
> * 
> *
>- * @see IEvaluationContext#evaluateCodeSnippet(String, ICodeSnippetRequestor, IProgressMonitor)
>- * @see IEvaluationContext#evaluateCodeSnippet(String, String[], String[], int[], IType, boolean, boolean, ICodeSnippetRequestor, IProgressMonitor)
>+ * @see IEvaluationContext#evaluateCodeSnippet(String, ICodeSnippetRequestor, org.eclipse.core.runtime.IProgressMonitor)
>+ * @see IEvaluationContext#evaluateCodeSnippet(String, String[], String[], int[], org.eclipse.jdt.core.IType, boolean, boolean, ICodeSnippetRequestor, org.eclipse.core.runtime.IProgressMonitor)
> */
> public interface ICodeSnippetRequestor {
> 	
>Index: model/org/eclipse/jdt/core/jdom/IDOMImport.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/model/org/eclipse/jdt/core/jdom/IDOMImport.java,v
>retrieving revision 1.11
>diff -u -r1.11 IDOMImport.java
>--- model/org/eclipse/jdt/core/jdom/IDOMImport.java	10 May 2004 08:50:28 -0000	1.11
>+++ model/org/eclipse/jdt/core/jdom/IDOMImport.java	18 May 2004 19:33:15 -0000
>@@ -42,7 +42,7 @@
> * Returns the modifier flags for this import. The flags can be examined using class
> * <code>Flags</code>. Only the static flag is meaningful for import declarations.
> * @return the modifier flags for this import
>- * @see Flags
>+ * @see org.eclipse.jdt.core.Flags
> * @since 3.0
> */
> int getFlags();
>@@ -57,7 +57,7 @@
> * and subject to change.
> * 
> * @param flags the modifier flags for this import
>- * @see Flags
>+ * @see org.eclipse.jdt.core.Flags
> * @since 3.0
> */
> void setFlags(int flags);
>Index: search/org/eclipse/jdt/core/search/IJavaSearchScope.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/IJavaSearchScope.java,v
>retrieving revision 1.21
>diff -u -r1.21 IJavaSearchScope.java
>--- search/org/eclipse/jdt/core/search/IJavaSearchScope.java	20 Apr 2004 10:12:11 -0000	1.21
>+++ search/org/eclipse/jdt/core/search/IJavaSearchScope.java	18 May 2004 19:33:15 -0000
>@@ -93,7 +93,7 @@
> * 
> * @return whether this scope contains any <code>.class</code> files
> * @deprecated Use
>- * {@link org.eclipse.jdt.core.search.SearchEngine#createJavaSearchScope(IJavaElement[]))
>+ * {@link org.eclipse.jdt.core.search.SearchEngine#createJavaSearchScope(IJavaElement[]))}
> * with the package fragment roots that correspond to the binaries instead.
> */
> boolean includesBinaries();
>@@ -103,7 +103,7 @@
> * 
> * @return whether this scope includes classpaths
> * @deprecated Use
>- * {@link org.eclipse.jdt.core.search.SearchEngine#createJavaSearchScope(IJavaElement[]))
>+ * {@link org.eclipse.jdt.core.search.SearchEngine#createJavaSearchScope(IJavaElement[]))}
> * with a Java project instead.
> */
> boolean includesClasspaths();
>@@ -113,7 +113,7 @@
> * 
> * @param includesBinaries whether this scope contains any <code>.class</code> files
> * @deprecated Use
>- * {@link org.eclipse.jdt.core.search.SearchEngine#createJavaSearchScope(IJavaElement[]))
>+ * {@link org.eclipse.jdt.core.search.SearchEngine#createJavaSearchScope(IJavaElement[]))}
> * with the package fragment roots that correspond to the binaries instead.
> */
> public void setIncludesBinaries(boolean includesBinaries);
>@@ -123,7 +123,7 @@
> * 
> * @param includesClasspaths whether this scope includes classpaths
> * @deprecated Use
>- * {@link org.eclipse.jdt.core.search.SearchEngine#createJavaSearchScope(IJavaElement[]))
>+ * {@link org.eclipse.jdt.core.search.SearchEngine#createJavaSearchScope(IJavaElement[]))}
> * with a Java project instead.
> */
> public void setIncludesClasspaths(boolean includesClasspaths);
>Index: search/org/eclipse/jdt/core/search/SearchDocument.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchDocument.java,v
>retrieving revision 1.8
>diff -u -r1.8 SearchDocument.java
>--- search/org/eclipse/jdt/core/search/SearchDocument.java	23 Apr 2004 17:06:53 -0000	1.8
>+++ search/org/eclipse/jdt/core/search/SearchDocument.java	18 May 2004 19:33:15 -0000
>@@ -41,7 +41,7 @@
> 	/**
> 	 * Adds the given index entry (category and key) coming from this
> 	 * document to the index. This method must be called from
>-	 * {@link SearchParticipant#indexDocument(SearchDocument document, org.eclipse.core.runtime.IPath indexPath).
>+	 * {@link SearchParticipant#indexDocument(SearchDocument document, org.eclipse.core.runtime.IPath indexPath)}.
> 	 * 
> 	 * @param category the category of the index entry
> 	 * @param key the key of the index entry
>@@ -110,7 +110,7 @@
> 	/**
> 	 * Removes all index entries from the index for the given document.
> 	 * This method must be called from 
>-	 * {@link SearchParticipant#indexDocument(SearchDocument document, org.eclipse.core.runtime.IPath indexPath).
>+	 * {@link SearchParticipant#indexDocument(SearchDocument document, org.eclipse.core.runtime.IPath indexPath)}.
> 	 */
> 	public void removeAllIndexEntries() {
> 		super.removeAllIndexEntries();
>Index: search/org/eclipse/jdt/core/search/SearchParticipant.java
>===================================================================
>RCS file: /data/cvs/eclipse/org.eclipse.jdt.core/search/org/eclipse/jdt/core/search/SearchParticipant.java,v
>retrieving revision 1.13
>diff -u -r1.13 SearchParticipant.java
>--- search/org/eclipse/jdt/core/search/SearchParticipant.java	13 May 2004 16:33:27 -0000	1.13
>+++ search/org/eclipse/jdt/core/search/SearchParticipant.java	18 May 2004 19:33:15 -0000
>@@ -108,7 +108,7 @@
> 	/**
> 	 * Indexes the given document in the given index. A search participant
> 	 * asked to index a document should parse it and call 
>-	 * {@link #addIndexEntry(char[], char[], SearchDocument)} as many times as
>+	 * {@link SearchDocument#addIndexEntry(char[], char[])} as many times as
> 	 * needed to add index entries to the index. If delegating to another
> 	 * participant, it should use the original index location (and not the
> 	 * delegatee's one). In the particular case of delegating to the default

Actions: View

Attachments on bug 62769: 10795 | 10809 | 11047