diff --git a/pom.xml b/pom.xml index a4af53255..6aec98e4a 100644 --- a/pom.xml +++ b/pom.xml @@ -475,6 +475,9 @@ under the License. ${project.build.directory}/local-repo src/it/projects src/it/mrm/settings.xml + + examples/*/pom.xml + MJAVADOC-181/pom.xml output-encoding/pom.xml diff --git a/src/it/projects/examples/alternate-doclet/invoker.properties b/src/it/projects/examples/alternate-doclet/invoker.properties new file mode 100644 index 000000000..026438d3a --- /dev/null +++ b/src/it/projects/examples/alternate-doclet/invoker.properties @@ -0,0 +1,20 @@ +# 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. + +# this plugins expects tools.jar, hence Java 8 or before +invoker.java.version=9- +invoker.goals=javadoc:javadoc diff --git a/src/it/projects/examples/alternate-doclet/pom.xml b/src/it/projects/examples/alternate-doclet/pom.xml new file mode 100644 index 000000000..c477ce059 --- /dev/null +++ b/src/it/projects/examples/alternate-doclet/pom.xml @@ -0,0 +1,56 @@ + + + + 4.0.0 + + org.apache.maven.plugins.javadoc.example + alternate-doclet + 1.0.0-SNAPSHOT + + + UTF-8 + @maven.compiler.source@ + @maven.compiler.target@ + + + http://maven.apache.org/plugins/maven-javadoc-plugin/examples/alternate-doclet.html + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + @project.version@ + + org.umlgraph.doclet.UmlGraphDoc + + + org.umlgraph + umlgraph + 5.6.6 + + -views + + + + + + diff --git a/src/it/projects/examples/alternate-doclet/src/main/java/com/example/Foo.java b/src/it/projects/examples/alternate-doclet/src/main/java/com/example/Foo.java new file mode 100644 index 000000000..b1a91facd --- /dev/null +++ b/src/it/projects/examples/alternate-doclet/src/main/java/com/example/Foo.java @@ -0,0 +1,31 @@ +package com.example; + +/* + * 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. + */ + +/** + * This is a Foo. + */ +public interface Foo +{ + /** + * Frobnicates the foo. + */ + public void frobnicate(); +} diff --git a/src/it/projects/examples/alternate-doclet/verify.groovy b/src/it/projects/examples/alternate-doclet/verify.groovy new file mode 100644 index 000000000..c16fc76ac --- /dev/null +++ b/src/it/projects/examples/alternate-doclet/verify.groovy @@ -0,0 +1,24 @@ +/* + * 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. + */ + +File options = new File( basedir, 'target/site/apidocs/options' ) + +assert options.text.readLines().dropWhile{it != '-doclet'}.get(1) == "'org.umlgraph.doclet.UmlGraphDoc'" +assert options.text.readLines().dropWhile{it != '-docletpath'}.get(1).contains('org/umlgraph/umlgraph/5.6.6/umlgraph-5.6.6.jar') + diff --git a/src/site/apt/examples/alternate-doclet.apt.vm b/src/site/apt/examples/alternate-doclet.apt.vm index 04cbbbc70..be1f79848 100644 --- a/src/site/apt/examples/alternate-doclet.apt.vm +++ b/src/site/apt/examples/alternate-doclet.apt.vm @@ -37,35 +37,7 @@ Using Alternate Doclet <>: You must have the Graphviz binary in your PATH, or the images will not be generated. For more information about Graphviz, please refer to {{http://www.graphviz.org/}}. -+-----+ - - ... - (or ) - - - org.apache.maven.plugins - maven-javadoc-plugin - ${project.version} - - org.umlgraph.doclet.UmlGraphDoc - - - - org.umlgraph - doclet - 5.1 - - - -views - - - - ... - - (or ) - ... - -+-----+ +%{snippet|id=umlgraph|file=target/it/examples/alternate-doclet/pom.xml} <>: