gnodet commented on code in PR #2023:
URL: https://github.com/apache/maven/pull/2023#discussion_r1904112105
##########
api/maven-api-model/src/main/mdo/maven.mdo:
##########
@@ -104,9 +104,9 @@
<field xdoc.separator="blank">
<name>parent</name>
<version>4.0.0+</version>
- <description>The location of the parent project, if one exists.
Values from the parent
+ <description>Returns the coordinates of the parent project, if one
exists. Values from the parent
Review Comment:
The `description` fields are not only used to document the getter.
In maven 3, the description is used to generate javadoc for the field,
getter and setter:
*
https://maven.apache.org/ref/3.9.6/maven-model/xref/org/apache/maven/model/Model.html#L36
*
https://maven.apache.org/ref/3.9.6/maven-model/xref/org/apache/maven/model/Model.html#L603
*
https://maven.apache.org/ref/3.9.6/maven-model/xref/org/apache/maven/model/Model.html#L954
The modello used to slightly transform the description at generation time to
accommodate the field, getter and setter. Maybe we should get back to that
behavior instead ? I'd rather keep the model descriptive and not tied to the
generator.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
