Skip to content

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.

Sign up for GitHub

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

Open
anukalp2804 wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −1
Open

docs: clarify replacement for deprecated scriptSourceDirectory #11651

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion api/maven-api-model/src/main/mdo/maven.mdo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -925,7 +925,9 @@
interpreted rather than compiled).
The default value is {@code src/main/scripts}.

@deprecated Replaced by {@code <Source>} with {@code script} language.
@deprecated since 4.0.0.
Use {@code <source>} elements with {@code script} language
Copy link
Contributor

@elharo elharo Jan 20, 2026

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?

Copy link
Contributor Author

@anukalp2804 anukalp2804 Jan 20, 2026

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.

Copy link
Contributor

@desruisseaux desruisseaux Jan 20, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Note: {@code &lt;source&gt;} 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.

Copy link
Contributor

@elharo elharo Jan 20, 2026

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?

Copy link
Contributor Author

@anukalp2804 anukalp2804 Jan 21, 2026

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.

to configure script sources.
</description>
<type>String</type>
<annotations>
Expand Down