Bug 52264 - Need a global preference to enable Javadoc support
Summary: Need a global preference to enable Javadoc support
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.0   Edit
Hardware: PC Windows 2000
: P3 normal (vote)
Target Milestone: 3.0 M8   Edit
Assignee: Frederic Fusier CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks: 51529
  Show dependency tree
 
Reported: 2004-02-17 11:44 EST by Philipe Mulet CLA
Modified: 2004-03-25 09:52 EST (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Philipe Mulet CLA 2004-02-17 11:44:16 EST
Build 3.0 M7

This setting would allow to enable Javadoc parsing/resolving/checking in a 
silent way, independantly from having it report problems.

When disabled, search should not find matches in Javadocs. DOM AST would not 
contain structured Javadoc.

When enabled, unused import diagnosis would reflect Javadoc usage.
Comment 1 Frederic Fusier CLA 2004-03-04 13:23:06 EST
Fixed.

Additional JavaCore.COMPILER_DOC_COMMENT_SUPPORT option has been added:
 * COMPILER / Javadoc Comment Support
 *    When this support is disabled, the compiler will ignore all javadoc
      problems options settings
 *    and will not report any javadoc problem. It will also not find any 
      reference in javadoc comment and
 *    DOM AST Javadoc node will be only a flat text instead of having 
      structured tag elements.
 *     - option id:         "org.eclipse.jdt.core.compiler.doc.comment.support"
 *     - possible values:   { "enabled", "disabled" }
 *     - default:           "enabled"

Note that corresponding Compiler option is disabled by default and user will 
need to specify -warn:javadoc or -warn:allJavadoc option has before to let the 
batch compiler parse javadoc comments...

[jdt-core-internal]
Dvpt
====
Following classes have been modified to take into account this new option:
1) New option definition: Main, CompilerOptions, JavaCore, JavaProject
2) Field checkDocComment initialization:
   AbstractCommentParser, JavadocParser, DocCommentParser, 
   CommentRecorderParser, MatchLocatorParser
3) Problem reporting: ProblemReporter
4) AST conversion: ASTConverter
Tests
=====
1) Test cases added in jdt.core.tests.compiler.regression.JavadocTestMixed, 
jdt.core.tests.compiler.regression.JavadocTestOptions, 
jdt.core.tests.dom.ASTConverterJavadocTests and 
jdt.core.tests.dom.JavaSearchJavadocTests
2) All already existing Javadoc compiler tests are now run with global option 
disabled to verify that compiler never complains on invalid or missing 
tags/comments.
3) All already existing DOM/AST Javadoc convertion are now run with global 
option disabled to verify that Javadoc node is flat text instead having 
structured children tags.
4) All already existing Javadoc searches are now run with global option 
disabled to verify that no reference will be found in Javadoc comments.
Comment 2 Jerome Lanneluc CLA 2004-03-25 09:52:05 EST
Verified in I200403250010.