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

[MPLUGIN-442] Generate goal documentation leveraging Sink API #225

Merged
merged 10 commits into from
Oct 8, 2023

Conversation

kwin
Copy link
Member

@kwin kwin commented Sep 7, 2023

Drop XDoc intermediate format

@michael-o
Copy link
Member

Will happily review, leave me a couple of days...

@kwin kwin force-pushed the feature/remove-xdoc-intermediate-format branch from 6e1504a to ca6df87 Compare September 7, 2023 18:18
@kwin
Copy link
Member Author

kwin commented Sep 27, 2023

@michael-o Any more comments on the anchors being generated?

@michael-o michael-o self-requested a review September 27, 2023 14:14
Copy link
Member

@michael-o michael-o left a comment

Choose a reason for hiding this comment

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

So far so good, let me run and compare myself and think about your open question in the next couple of days...

@michael-o michael-o self-requested a review September 27, 2023 14:20
@kwin kwin force-pushed the feature/remove-xdoc-intermediate-format branch from e677aa9 to a92577d Compare October 5, 2023 17:39
@kwin kwin requested a review from michael-o October 5, 2023 17:42
@kwin kwin force-pushed the feature/remove-xdoc-intermediate-format branch from 205de0e to f6dc034 Compare October 6, 2023 10:30
@kwin kwin requested a review from michael-o October 6, 2023 15:23
@michael-o
Copy link
Member

See also checkstyle/checkstyle#13016

@kwin kwin force-pushed the feature/remove-xdoc-intermediate-format branch from 41ca383 to 1696e35 Compare October 8, 2023 15:22
Copy link
Member

@michael-o michael-o left a comment

Choose a reason for hiding this comment

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

This looks good now to me.

@kwin kwin merged commit 679d822 into master Oct 8, 2023
3 of 7 checks passed
Comment on lines +277 to +279
if (StringUtils.isNotEmpty(parameter.getDeprecated())) {
String deprecated = getXhtmlWithValidatedLinks(parameter.getDescription(), context);
description = format("parameter.deprecated", deprecated);
Copy link
Member

Choose a reason for hiding this comment

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

@kwin @michael-o
Is it intended - we check parameter.getDeprecated() but use parameter.getDescription()?

We lost here deprecated reason ... only deprecated label with standard description is printed.

Copy link
Member Author

@kwin kwin Dec 25, 2023

Choose a reason for hiding this comment

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

That is a copy-paste mistake. It is supposed to print the deprecation text.

Copy link
Member

Choose a reason for hiding this comment

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

The removed Xdoc generator had it right. @slawekjaranowski Please file an issue. We need to fix this.

@michael-o michael-o deleted the feature/remove-xdoc-intermediate-format branch December 25, 2023 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants