[jira] [Commented] (MNG-8029) improve documentation of mirror in settings

["ASF GitHub Bot (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/MNG-8029?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17813501#comment-17813501 ] 

ASF GitHub Bot commented on MNG-8029:
-------------------------------------

hboutemy commented on code in PR #1395:
URL: https://github.com/apache/maven/pull/1395#discussion_r1475609157


##########
maven-settings/src/main/mdo/settings.mdo:
##########
@@ -621,16 +626,24 @@
           <version>1.1.0+</version>
           <type>String</type>
           <defaultValue>default</defaultValue>
-          <description>The layout of the mirror repository. Since Maven 3.</description>
+          <description>
+            <![CDATA[
+            The layout of the mirror repository.
+            <br><b>Since</b>: Maven 3

Review Comment:
   because I just reused the existing pattern
   I don't know if `@since` works with Modello xdoc, need to check: doing the pattern change in every `.mdo` could be a good thing for another PR





> improve documentation of mirror in settings
> -------------------------------------------
>
>                 Key: MNG-8029
>                 URL: https://issues.apache.org/jira/browse/MNG-8029
>             Project: Maven
>          Issue Type: Improvement
>    Affects Versions: 3.9.6, 4.0.0-alpha-12
>            Reporter: Herve Boutemy
>            Priority: Major
>             Fix For: 3.9.7, 4.0.0-alpha-13
>
>
> reading https://maven.apache.org/ref/3.9.6/maven-settings/settings.html#class_mirror
> and comparing to https://maven.apache.org/guides/mini/guide-mirror-settings.html
> model documentation does not explain that mirrorOf is not just an id, but has much more flexibility (since Maven versions to be clarified)
> and id has no description
> it's time to clarify
> and also update "reference settings documentation" which is completely obsolete on mirror: https://maven.apache.org/settings.html



--
This message was sent by Atlassian Jira
(v8.20.10#820010)