-
Notifications
You must be signed in to change notification settings - Fork 2.8k
docs: clarify replacement for deprecated scriptSourceDirectory #11651
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
base: master
Are you sure you want to change the base?
docs: clarify replacement for deprecated scriptSourceDirectory #11651
Conversation
|
@Bukama , @slachiewicz The change is documentation-only and does not introduce any behavioral or API changes. |
|
|
||
| @deprecated Replaced by {@code <Source>} with {@code script} language. | ||
| @deprecated since 4.0.0. | ||
| Use {@code <source>} elements with {@code script} language |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it Source or source?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it should be lowercase <source>, matching the Maven POM XML element name.
The current wording intentionally uses <source> for that reason.
Please let me know if you’d like this phrasing adjusted further.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: {@code <source>} should be {@code <source>}. HTML character entities are automatically escaped when inside {@code} or {@literal}.
EDIT: Oups! Sorry, ignore that comment. I just saw that this is inside a .mdo file, not a .java file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How does mdo work here? Does it first copy this into a .java file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes — the .mdo file is the source of truth.
During the build, Maven’s model generator processes the .mdo and generates the corresponding Java model classes and JavaDoc from it.
That’s why the XML escaping (e.g. <source>) is needed in the .mdo, even though the generated JavaDoc ends up with the correct <source> rendering.
|
Thanks for the clarification! |
Summary
Clarifies replacement guidance for the deprecated
scriptSourceDirectorymodel field.Details
Relates to #11504
Following this checklist to help us incorporate your
contribution quickly and easily:
Note that commits might be squashed by a maintainer on merge.
This may not always be possible but is a best-practice.
mvn verifyto make sure basic checks pass.A more thorough check will be performed on your pull request automatically.
If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.