Important Notice: Our web hosting provider recently started charging us for additional visits, which was unexpected. In response, we're seeking donations. Depending on the situation, we may explore different monetization options for our Community and Expert Contributors. It's crucial to provide more returns for their expertise and offer more Expert Validated Answers or AI Validated Answers. Learn more about our hosting issue here.

What is the purpose of displaying read-only, plug-in fields in user documentation, if they are not configurable in the project descriptor?

April 26, 2017configurable descriptor displaying documentation Fields plug-in project purpose read-only user

0

Posted

What is the purpose of displaying read-only, plug-in fields in user documentation, if they are not configurable in the project descriptor?

2 Answers

0

Posted

Often, parameters are specified as read-only to indicate that its value should be changed indirectly, rather than in the plugins section. For instance, I may have a plugin that declares a parameter as such: /** * @parameter default-value=”${project.build.directory}” * @required * @readonly */ private File buildDir; In this case, my plugin wants to output something to the project’s build directory. If this were configured directly on the plugin, it might not be cleaned up when the user issued ‘mvn clean’, so instead I mark it as @readonly. This tells the user that she should modify the structure referenced by default-value(i.e. in the POM) instead, which will allow this plugin to be a good citizen in the build process.

0

10 Posted

Often, parameters are specified as read-only to indicate that its value should be changed indirectly, rather than in the plugins section.