diff --git a/maven-plugin-plugin/src/it/mplugin-324_javadoc/invoker.properties b/maven-plugin-plugin/src/it/mplugin-324_javadoc/invoker.properties new file mode 100644 index 0000000..e1c03fc --- /dev/null +++ b/maven-plugin-plugin/src/it/mplugin-324_javadoc/invoker.properties @@ -0,0 +1,18 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +invoker.goals = process-classes javadoc:javadoc diff --git a/maven-plugin-plugin/src/it/mplugin-324_javadoc/pom.xml b/maven-plugin-plugin/src/it/mplugin-324_javadoc/pom.xml new file mode 100644 index 0000000..ee646a9 --- /dev/null +++ b/maven-plugin-plugin/src/it/mplugin-324_javadoc/pom.xml @@ -0,0 +1,95 @@ + + + + + + 4.0.0 + + org.apache.maven.plugins.plugin.its + mplugin3224 + 1.0-SNAPSHOT + maven-plugin + + + Generation javadoc for private methods should be valid + + + + UTF-8 + + + + + org.apache.maven + maven-plugin-api + 2.0 + + + org.codehaus.plexus + plexus-utils + 3.0.1 + + + org.apache.maven.plugin-tools + maven-plugin-annotations + @project.version@ + provided + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 2.4 + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.0.0-M1 + + private + + + + + + + org.apache.maven.plugins + maven-plugin-plugin + @project.version@ + + + default-descriptor + process-classes + + + help-goal + + helpmojo + + + + + + + diff --git a/maven-plugin-plugin/src/it/mplugin-324_javadoc/src/main/java/test/MyMojo.java b/maven-plugin-plugin/src/it/mplugin-324_javadoc/src/main/java/test/MyMojo.java new file mode 100644 index 0000000..8e7dec5 --- /dev/null +++ b/maven-plugin-plugin/src/it/mplugin-324_javadoc/src/main/java/test/MyMojo.java @@ -0,0 +1,68 @@ +package test; + +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; + +/** + * MOJO-DESCRIPTION. Some "quotation" marks and backslashes '\\', some important javadoc
and an + * inline link to {@link org.apache.maven.plugin.AbstractMojo}. + * + * @deprecated As of 1.0, use the "quoted" goal instead. + * @since 2.1 + */ +@Mojo( name= "test" ) +public class MyMojo + extends AbstractMojo +{ + + /** + * This parameter uses "quotation" marks and backslashes '\\' in its description. Those characters must be + * escaped in Java string literals. + * + * @since 2.0 + */ + @Parameter( defaultValue = "escape\\backslash" ) + private String defaultParam; + + /** + * This parameter is deprecated. + * + * @deprecated As of version 1.0, use the {@link #defaultParam} instead. + */ + @Parameter + private String deprecatedParam; + + @Parameter( property = "test.undocumented", required = true ) + private String undocumentedParam; + + /** + * Readonly parameter: should not be proposed for configuration. + */ + @Parameter( defaultValue = "not for configuration", readonly = true ) + private String readonly; + + public void execute() + { + } + +} diff --git a/maven-plugin-tools-generators/src/main/resources/help-class-source.vm b/maven-plugin-tools-generators/src/main/resources/help-class-source.vm index b618c0e..4e733fe 100644 --- a/maven-plugin-tools-generators/src/main/resources/help-class-source.vm +++ b/maven-plugin-tools-generators/src/main/resources/help-class-source.vm @@ -398,7 +398,7 @@ public class HelpMojo * @param indentSize The size of each indentation, must not be negative. * @param lineLength The length of the line, must not be negative. * @return The sequence of display lines, never null. - * @throws NegativeArraySizeException if indent < 0 + * @throws NegativeArraySizeException if indent < 0 */ private static List toLines( String text, int indent, int indentSize, int lineLength ) {