[jira] (MPLUGIN-237) JavaDoc WARNING on generated HelpMojo class.
[
https://jira.codehaus.org/browse/MPLUGIN-237?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Herve Boutemy closed MPLUGIN-237.
-
Resolution: Fixed
Fix Version/s: 3.3
Assignee: Herve Boutemy
fixed in [r1508587|http://svn.apache.org/r1508587]
JavaDoc WARNING on generated HelpMojo class.
Key: MPLUGIN-237
URL: https://jira.codehaus.org/browse/MPLUGIN-237
Project: Maven 2.x Plugin Tools
Issue Type: Improvement
Components: Plugin Plugin
Affects Versions: 3.2
Reporter: Karl Heinz Marbaise
Assignee: Herve Boutemy
Priority: Minor
Fix For: 3.3
During the site generation of a maven-plugin i got the following warning in
the builds:
{code}
2 warnings
[WARNING] Javadoc Warnings
[WARNING] /opt/.../plugin/.../HelpMojo.java:30: warning - @author tag has no
arguments.
[WARNING] /opt/.../plugin/.../HelpMojo.java:30: warning - @version tag has no
arguments.
[INFO] Generating Test JavaDocs report--- maven-javadoc-plugin:2.9
{code}
The question is: Can this be automatically be generated by the
maven-plugin-plugin from the original Mojo Class to avoid this WARNING?
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] (MPLUGIN-237) JavaDoc WARNING on generated HelpMojo class.
[
https://jira.codehaus.org/browse/MPLUGIN-237?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=326959#comment-326959
]
SebbASF commented on MPLUGIN-237:
-
Agreed; the @author and @version fields could be dropped.
Alternatively, they could be used to document the name and version of the
plugin that creates the file ...
JavaDoc WARNING on generated HelpMojo class.
Key: MPLUGIN-237
URL: https://jira.codehaus.org/browse/MPLUGIN-237
Project: Maven 2.x Plugin Tools
Issue Type: Improvement
Components: Plugin Plugin
Affects Versions: 3.2
Reporter: Karl Heinz Marbaise
Priority: Minor
During the site generation of a maven-plugin i got the following warning in
the builds:
{code}
2 warnings
[WARNING] Javadoc Warnings
[WARNING] /opt/.../plugin/.../HelpMojo.java:30: warning - @author tag has no
arguments.
[WARNING] /opt/.../plugin/.../HelpMojo.java:30: warning - @version tag has no
arguments.
[INFO] Generating Test JavaDocs report--- maven-javadoc-plugin:2.9
{code}
The question is: Can this be automatically be generated by the
maven-plugin-plugin from the original Mojo Class to avoid this WARNING?
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] (MPLUGIN-237) JavaDoc WARNING on generated HelpMojo class.
[
https://jira.codehaus.org/browse/MPLUGIN-237?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=318600#comment-318600
]
Anthony Whitford commented on MPLUGIN-237:
--
Yes, this bugs me too. I'm OK with dropping {{@author}} and {{@version}}
altogether from the HelpMojo's javadoc. I don't really see how {{@author}}
applies to something generated. And who cares about {{@version}} for a _help
mojo_?
JavaDoc WARNING on generated HelpMojo class.
Key: MPLUGIN-237
URL: https://jira.codehaus.org/browse/MPLUGIN-237
Project: Maven 2.x Plugin Tools
Issue Type: Improvement
Components: Plugin Plugin
Affects Versions: 3.2
Reporter: Karl Heinz Marbaise
Priority: Minor
During the site generation of a maven-plugin i got the following warning in
the builds:
{code}
2 warnings
[WARNING] Javadoc Warnings
[WARNING] /opt/.../plugin/.../HelpMojo.java:30: warning - @author tag has no
arguments.
[WARNING] /opt/.../plugin/.../HelpMojo.java:30: warning - @version tag has no
arguments.
[INFO] Generating Test JavaDocs report--- maven-javadoc-plugin:2.9
{code}
The question is: Can this be automatically be generated by the
maven-plugin-plugin from the original Mojo Class to avoid this WARNING?
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] (MPLUGIN-237) JavaDoc WARNING on generated HelpMojo class.
[
https://jira.codehaus.org/browse/MPLUGIN-237?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=318602#comment-318602
]
Anthony Whitford commented on MPLUGIN-237:
--
Here is an example link suggesting that the {{@author}} tag should be avoided
because it is usually inaccurate (see your revision history instead):
* http://www.databasesandlife.com/dont-use-the-author-javadoc-tag/
JavaDoc WARNING on generated HelpMojo class.
Key: MPLUGIN-237
URL: https://jira.codehaus.org/browse/MPLUGIN-237
Project: Maven 2.x Plugin Tools
Issue Type: Improvement
Components: Plugin Plugin
Affects Versions: 3.2
Reporter: Karl Heinz Marbaise
Priority: Minor
During the site generation of a maven-plugin i got the following warning in
the builds:
{code}
2 warnings
[WARNING] Javadoc Warnings
[WARNING] /opt/.../plugin/.../HelpMojo.java:30: warning - @author tag has no
arguments.
[WARNING] /opt/.../plugin/.../HelpMojo.java:30: warning - @version tag has no
arguments.
[INFO] Generating Test JavaDocs report--- maven-javadoc-plugin:2.9
{code}
The question is: Can this be automatically be generated by the
maven-plugin-plugin from the original Mojo Class to avoid this WARNING?
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] (MPLUGIN-237) JavaDoc WARNING on generated HelpMojo class.
Karl Heinz Marbaise created MPLUGIN-237:
---
Summary: JavaDoc WARNING on generated HelpMojo class.
Key: MPLUGIN-237
URL: https://jira.codehaus.org/browse/MPLUGIN-237
Project: Maven 2.x Plugin Tools
Issue Type: Improvement
Components: Plugin Plugin
Affects Versions: 3.2
Reporter: Karl Heinz Marbaise
Priority: Minor
During the site generation of a maven-plugin i got the following warning in the
builds:
{code}
2 warnings
[WARNING] Javadoc Warnings
[WARNING] /opt/.../plugin/.../HelpMojo.java:30: warning - @author tag has no
arguments.
[WARNING] /opt/.../plugin/.../HelpMojo.java:30: warning - @version tag has no
arguments.
[INFO] Generating Test JavaDocs report--- maven-javadoc-plugin:2.9
{code}
The question is: Can this be automatically be generated by the
maven-plugin-plugin from the original Mojo Class to avoid this WARNING?
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators:
https://jira.codehaus.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
