Bug 62769 - Javadoc errors in 200405180816
Summary: Javadoc errors in 200405180816
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.0   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.0 RC1   Edit
Assignee: Olivier Thomann CLA
QA Contact:
URL:
Whiteboard:
Keywords:
: 62758 (view as bug list)
Depends on:
Blocks:
 
Reported: 2004-05-18 15:46 EDT by Olivier Thomann CLA
Modified: 2004-05-28 16:13 EDT (History)
1 user (show)

See Also:


Attachments
Fix javadocs for API (15.97 KB, text/plain)
2004-05-18 15:48 EDT, Olivier Thomann CLA
no flags Details
Apply this patch to fix all problems related to javadoc for JDT/Core API (5.08 KB, application/octet-stream)
2004-05-18 17:27 EDT, Olivier Thomann CLA
no flags Details
Run with ant after pasting it in the org.eclipse.jdt.core project's root (6.49 KB, text/plain)
2004-05-25 09:52 EDT, Olivier Thomann CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Olivier Thomann CLA 2004-05-18 15:46:49 EDT
Some javadoc contains invalid javadoc tags.
I will attach a patch for the API types.
Comment 1 Olivier Thomann CLA 2004-05-18 15:48:05 EDT
Created attachment 10795 [details]
Fix javadocs for API
Comment 2 Olivier Thomann CLA 2004-05-18 16:02:15 EDT
*** Bug 62758 has been marked as a duplicate of this bug. ***
Comment 3 Olivier Thomann CLA 2004-05-18 17:27:10 EDT
Created attachment 10809 [details]
Apply this patch to fix all problems related to javadoc for JDT/Core API

Needs to be verified.
Comment 4 Olivier Thomann CLA 2004-05-18 22:21:39 EDT
All JDT/Core tests and JDT/UI tests pass with these changes.
Comment 5 Philipe Mulet CLA 2004-05-19 05:53:57 EDT
We should put this fix in for RC1. 
Frederic - pls verify patch.
Comment 6 Frederic Fusier CLA 2004-05-19 10:18:40 EDT
It's ok for me.

One thing here: there's now only one warning in ASTMatcher about reference to
deprecated method Javadoc#getComment(). Perhaps it would be nice to change the
comment to avoid it...

Perhaps it would be nice to have an additional option to avoid this kind of
warning...?
Comment 7 Olivier Thomann CLA 2004-05-25 09:43:59 EDT
Buildfile: c:\eclipse\workspaces\head2\org.eclipse.jdt.core\javadoc.xml
javadoc:
  [javadoc] Generating Javadoc
  [javadoc] Javadoc execution
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ICompilationUnit.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\CompletionProposal.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IJavaModelStatusConstants.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\NamingConventions.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\JavaModelException.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ToolFactory.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IBuffer.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\Signature.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IImportContainer.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IBufferChangedListener.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IParent.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\antadapter\org\eclipse\jdt\core\CheckDebugAttributes.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IOpenable.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IMethod.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ISourceRange.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ICodeCompletionRequestor.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IJavaProject.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IClassFile.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IType.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IJavaModelMarker.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\antadapter\org\eclipse\jdt\core\JDTCompilerAdapter.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\CompletionRequestor.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ElementChangedEvent.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IMember.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\Flags.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IRegion.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ClasspathVariableInitializer.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ICorrectionRequestor.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IProblemRequestor.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IWorkingCopy.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IField.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ITypeHierarchyChangedListener.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IPackageFragmentRoot.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\WorkingCopyOwner.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IJavaElementDelta.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IJavaModelStatus.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IInitializer.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IJavaModel.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ClasspathContainerInitializer.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IElementChangedListener.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ILocalVariable.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IJavaElement.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IPackageDeclaration.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IPackageFragment.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IBufferFactory.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ISourceReference.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\CorrectionEngine.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IImportDeclaration.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\BufferChangedEvent.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\CompletionRequestorAdapter.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\JavaCore.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\JavaConventions.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ITypeHierarchy.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ICodeFormatter.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ICodeAssist.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ISourceManipulation.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\ICompletionRequestor.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IClasspathEntry.java...
  [javadoc] Loading source file
C:\eclipse\workspaces\head2\org.eclipse.jdt.core\model\org\eclipse\jdt\core\IClasspathContainer.java...
  [javadoc] Loading source files for package org.eclipse.jdt.core.search...
  [javadoc] Loading source files for package org.eclipse.jdt.core.compiler...
  [javadoc] Loading source files for package org.eclipse.jdt.core.dom...
  [javadoc] Loading source files for package org.eclipse.jdt.core.dom.rewrite...
  [javadoc] Loading source files for package org.eclipse.jdt.core.eval...
  [javadoc] Loading source files for package org.eclipse.jdt.core.jdom...
  [javadoc] Loading source files for package org.eclipse.jdt.core.util...
  [javadoc] Loading source files for package org.eclipse.jdt.core.formatter...
  [javadoc] Constructing Javadoc information...
  [javadoc] Standard Doclet version 1.4.2_04
  [javadoc] Building tree for all the packages and classes...
  [javadoc] Building index for all the packages and classes...
  [javadoc] Building index for all classes...
  [javadoc] Generating C:\temp\jdt.core.doc\stylesheet.css...
BUILD SUCCESSFUL
Total time: 16 seconds

Fixed and released in HEAD.
Comment 8 Olivier Thomann CLA 2004-05-25 09:52:46 EDT
Created attachment 11047 [details]
Run with ant after pasting it in the org.eclipse.jdt.core project's root

I attached a javadoc.xml to paste in the org.eclipse.jdt.core projects and run
with ant to verify this PR.
Comment 9 Olivier Thomann CLA 2004-05-28 16:13:16 EDT
Verified in 200405281200