Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

apidoc error/warning fix (#6) #5734

Merged
merged 1 commit into from
Mar 29, 2023
Merged

Conversation

ebarboni
Copy link
Contributor

@ebarboni ebarboni commented Mar 28, 2023

This is a sixth split of the big PR #4450.
using the following to have ant javadoc -Dmetabuild.branch=master -Dapidocfullcheck=true.

About 3/4 of the module pass.

I did a comment on a code modification that is removal of import. I don't know why it fails with this import. Many classes have unused import and no issue.

As part of the refactoring.api fixes it seems that annotationprocessor is supporting a never implemented type. (see inline comment)

@ebarboni ebarboni added the JavaDoc [ci] enable java/javadoc tests and build-javadoc target label Mar 28, 2023
@ebarboni ebarboni requested a review from mbien March 28, 2023 16:59
@@ -70,7 +70,6 @@
import javax.swing.text.html.HTML;
import javax.swing.text.html.HTMLEditorKit;
import javax.swing.text.html.parser.ParserDelegator;
import org.netbeans.api.*;
import org.netbeans.api.annotations.common.CheckForNull;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this removal seems mandatory to get javadoc

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

always good to avoid star imports

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

firmly agree!

@@ -72,7 +71,6 @@ public abstract class ScopeProvider {
*
* @see ScopeProvider#initialize(org.openide.util.Lookup,
* java.util.concurrent.atomic.AtomicBoolean)
* @see ScopeDescription
* @return an icon for the Scope, or null if the default should be used.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this class was never implemented.
was intended first https://bz.apache.org/netbeans/show_bug.cgi?id=217347#a0 (see attachement).

https://github.com/apache/netbeans/blob/master/ide/refactoring.api/src/org/netbeans/modules/refactoring/spi/impl/ScopeAnnotationProcessor.java could be fixed to remove the SupportedAnnotationTypes ScopeDescription

Copy link
Member

@mbien mbien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looked through it and everything looks good to me.

please wait with merge till master is green again.

@ebarboni ebarboni merged commit 1177eba into apache:master Mar 29, 2023
@ebarboni
Copy link
Contributor Author

master is green merging

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
JavaDoc [ci] enable java/javadoc tests and build-javadoc target
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants