1 package org.codehaus.modello.maven; 2 3 /* 4 * Copyright (c) 2004, Codehaus.org 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy of 7 * this software and associated documentation files (the "Software"), to deal in 8 * the Software without restriction, including without limitation the rights to 9 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 10 * of the Software, and to permit persons to whom the Software is furnished to do 11 * so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in all 14 * copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 * SOFTWARE. 23 */ 24 25 import java.io.File; 26 import java.util.Properties; 27 28 import org.apache.maven.plugins.annotations.Mojo; 29 import org.apache.maven.plugins.annotations.Parameter; 30 import org.codehaus.modello.ModelloParameterConstants; 31 32 /** 33 * Creates documentation for the model in xdoc format. 34 * 35 * @author <a href="mailto:brett@apache.org">Brett Porter</a> 36 */ 37 @Mojo(name = "xdoc", threadSafe = true) 38 public class ModelloXdocMojo extends AbstractModelloGeneratorMojo { 39 /** 40 * The output directory of the generated documentation. 41 */ 42 @Parameter(defaultValue = "${project.build.directory}/generated-site/xdoc", required = true) 43 private File outputDirectory; 44 45 /** 46 * 47 * @since 1.0-alpha-21 48 */ 49 @Parameter 50 private String xdocFileName; 51 52 /** 53 * The first version of the model. This is used to decide whether or not 54 * to show the since column. If this is not specified, it defaults to the 55 * version of the model, which in turn means that the since column will not 56 * be shown. 57 * 58 * @since 1.0-alpha-14 59 */ 60 @Parameter 61 private String firstVersion; 62 63 protected String getGeneratorType() { 64 return "xdoc"; 65 } 66 67 protected boolean producesCompilableResult() { 68 return false; 69 } 70 71 public File getOutputDirectory() { 72 return outputDirectory; 73 } 74 75 public void setOutputDirectory(File outputDirectory) { 76 this.outputDirectory = outputDirectory; 77 } 78 79 protected void customizeParameters(Properties parameters) { 80 super.customizeParameters(parameters); 81 82 // Use version if firstVersion was not specified 83 if (firstVersion == null) { 84 firstVersion = getVersion(); 85 } 86 87 parameters.put(ModelloParameterConstants.FIRST_VERSION, firstVersion); 88 89 if (xdocFileName != null) { 90 parameters.put(ModelloParameterConstants.OUTPUT_XDOC_FILE_NAME, xdocFileName); 91 } 92 } 93 94 public String getFirstVersion() { 95 return firstVersion; 96 } 97 98 public void setFirstVersion(String firstVersion) { 99 this.firstVersion = firstVersion; 100 } 101 }