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

Support for Markdown javadoc (JEP-467) #7491

Merged
merged 1 commit into from
Oct 10, 2024
Merged

Conversation

lahodaj
Copy link
Contributor

@lahodaj lahodaj commented Jun 17, 2024

A patch to support Markdown javadoc (JEP-467).

@mbien mbien added Java [ci] enable extra Java tests (java.completion, java.source.base, java.hints, refactoring.java, form) Platform [ci] enable platform tests (platform/*) ci:dev-build [ci] produce a dev-build zip artifact (7 days expiration, see link on workflow summary page) labels Jun 18, 2024
@mbien mbien added this to the NB24 milestone Jul 18, 2024
@lahodaj lahodaj marked this pull request as ready for review August 6, 2024 10:26
Copy link
Contributor

@dbalek dbalek left a comment

Choose a reason for hiding this comment

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

Looks fine to me. Thanks.

@lahodaj
Copy link
Contributor Author

lahodaj commented Oct 1, 2024

Unless there are objections, I will merge in the next day or so.

@mbien
Copy link
Member

mbien commented Oct 1, 2024

probably ok to merge as new feature, but I fear that this might confuse some of the javadoc editor hints since they probably don't expect markdown.

@lahodaj
Copy link
Contributor Author

lahodaj commented Oct 3, 2024

probably ok to merge as new feature, but I fear that this might confuse some of the javadoc editor hints since they probably don't expect markdown.

It might confuse something. Or some piece of code may be confused by the current situation (where the model already includes AST model of Markdown javadoc, but the JavadocUtilities don't understand it). I don't think this is an actionable claim, and I think this change is a step in finding out what's wrong, if anything, and fix it.

@mbien
Copy link
Member

mbien commented Oct 3, 2024

I don't think this is an actionable claim

it was just a feeling, but here an example after testing it quickly:

    ///
    /// @param str
    ///
    public static void foo(String str, int i) {}

the hint will suggest to insert the doc for i in the old format, ignoring that the method has already a block in the new format.

result:

    ///
    /// @param str
    ///

    /**
     *
     * @param str
     * @param i
     */
    public static void foo(String str, int i) {}

and I think this change is a step in finding out what's wrong, if anything, and fix it.

of course. That is why I said I think it is ok to merge this as new feature.

@lahodaj
Copy link
Contributor Author

lahodaj commented Oct 3, 2024

Hm, yes that happens. But it happens without this patch as well, so this is not something caused by this patch.

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.

forgot to approve - looks good!

@lahodaj lahodaj merged commit 0711bfc into apache:master Oct 10, 2024
37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:dev-build [ci] produce a dev-build zip artifact (7 days expiration, see link on workflow summary page) Java [ci] enable extra Java tests (java.completion, java.source.base, java.hints, refactoring.java, form) Platform [ci] enable platform tests (platform/*)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants