You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by kh...@apache.org on 2015/04/03 13:23:41 UTC
svn commit: r946183 [21/23] - in
/websites/production/maven/components/plugins-archives/maven-docck-plugin-LATEST:
./ apidocs/ apidocs/org/apache/maven/plugin/docck/
apidocs/org/apache/maven/plugin/docck/class-use/
apidocs/org/apache/maven/plugin/docck...
Modified: websites/production/maven/components/plugins-archives/maven-docck-plugin-LATEST/xref/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-docck-plugin-LATEST/xref/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.html (original)
+++ websites/production/maven/components/plugins-archives/maven-docck-plugin-LATEST/xref/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.html Fri Apr 3 11:23:40 2015
@@ -1,274 +1,268 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>CheckPluginDocumentationMojo xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.html">View Javadoc</a></div><pre>
-
-<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.docck;
-<a name="2" href="#2">2</a>
-<a name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
-<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
-<a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
-<a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
-<a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
-<a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
-<a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
-<a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
-<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
-<a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
-<a name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
-<a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
-<a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
-<a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
-<a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
-<a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
-<a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em>
-<a name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
-<a name="21" href="#21">21</a>
-<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.ReportPlugin;
-<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException;
-<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.MojoDescriptor;
-<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.Parameter;
-<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.PluginDescriptor;
-<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.docck.reports.DocumentationReporter;
-<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
-<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.tools.plugin.extractor.ExtractionException;
-<a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.tools.plugin.scanner.MojoScanner;
-<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.IOUtil;
-<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
-<a name="33" href="#33">33</a>
-<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.io.File;
-<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
-<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> java.io.Reader;
-<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
-<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
-<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> java.util.List;
-<a name="40" href="#40">40</a>
-<a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em>
-<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Checks a plugin's documentation for the standard minimums.</em>
-<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> *</em>
-<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @author jdcasey</em>
-<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @goal check</em>
-<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @aggregator</em>
-<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @phase validate</em>
-<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> */</em>
-<a name="49" href="#49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.html">CheckPluginDocumentationMojo</a>
-<a name="50" href="#50">50</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.html">AbstractCheckDocumentationMojo</a>
-<a name="51" href="#51">51</a> {
-<a name="52" href="#52">52</a>
-<a name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em>
-<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Plexus component that searches for Mojos.</em>
-<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> *</em>
-<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @component</em>
-<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> */</em>
-<a name="58" href="#58">58</a> <strong class="jxr_keyword">protected</strong> MojoScanner mojoScanner;
-<a name="59" href="#59">59</a>
-<a name="60" href="#60">60</a> <em class="jxr_comment">// TODO: really a description of length 1 isn't all that helpful...</em>
-<a name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MIN_DESCRIPTION_LENGTH = 1;
-<a name="62" href="#62">62</a>
-<a name="63" href="#63">63</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> checkPackagingSpecificDocumentation( MavenProject project, DocumentationReporter reporter )
-<a name="64" href="#64">64</a> {
-<a name="65" href="#65">65</a> PluginDescriptor descriptor = <strong class="jxr_keyword">new</strong> PluginDescriptor();
-<a name="66" href="#66">66</a>
-<a name="67" href="#67">67</a> <strong class="jxr_keyword">try</strong>
-<a name="68" href="#68">68</a> {
-<a name="69" href="#69">69</a> mojoScanner.populatePluginDescriptor( project, descriptor );
-<a name="70" href="#70">70</a> }
-<a name="71" href="#71">71</a> <strong class="jxr_keyword">catch</strong> ( InvalidPluginDescriptorException e )
-<a name="72" href="#72">72</a> {
-<a name="73" href="#73">73</a> reporter.error( <span class="jxr_string">"Failed to parse mojo descriptors.\nError: "</span> + e.getMessage() );
-<a name="74" href="#74">74</a> descriptor = <strong class="jxr_keyword">null</strong>;
-<a name="75" href="#75">75</a> }
-<a name="76" href="#76">76</a> <strong class="jxr_keyword">catch</strong> ( ExtractionException e )
-<a name="77" href="#77">77</a> {
-<a name="78" href="#78">78</a> reporter.error( <span class="jxr_string">"Failed to parse mojo descriptors.\nError: "</span> + e.getMessage() );
-<a name="79" href="#79">79</a> descriptor = <strong class="jxr_keyword">null</strong>;
-<a name="80" href="#80">80</a> }
-<a name="81" href="#81">81</a>
-<a name="82" href="#82">82</a> <strong class="jxr_keyword">if</strong> ( descriptor != <strong class="jxr_keyword">null</strong> )
-<a name="83" href="#83">83</a> {
-<a name="84" href="#84">84</a> List mojos = descriptor.getMojos();
-<a name="85" href="#85">85</a>
-<a name="86" href="#86">86</a> <em class="jxr_comment">// ensure that all mojo classes are documented</em>
-<a name="87" href="#87">87</a> <strong class="jxr_keyword">if</strong> ( mojos != <strong class="jxr_keyword">null</strong> && !mojos.isEmpty() )
-<a name="88" href="#88">88</a> {
-<a name="89" href="#89">89</a> <strong class="jxr_keyword">for</strong> ( Iterator it = mojos.iterator(); it.hasNext(); )
-<a name="90" href="#90">90</a> {
-<a name="91" href="#91">91</a> MojoDescriptor mojo = (MojoDescriptor) it.next();
-<a name="92" href="#92">92</a>
-<a name="93" href="#93">93</a> String mojoDescription = mojo.getDescription();
-<a name="94" href="#94">94</a>
-<a name="95" href="#95">95</a> <strong class="jxr_keyword">if</strong> ( mojoDescription == <strong class="jxr_keyword">null</strong> || mojoDescription.trim().length() < MIN_DESCRIPTION_LENGTH )
-<a name="96" href="#96">96</a> {
-<a name="97" href="#97">97</a> reporter.error( <span class="jxr_string">"Mojo: \'"</span> + mojo.getGoal() + <span class="jxr_string">"\' is missing a description."</span> );
-<a name="98" href="#98">98</a> }
-<a name="99" href="#99">99</a>
-<a name="100" href="#100">100</a> List params = mojo.getParameters();
-<a name="101" href="#101">101</a>
-<a name="102" href="#102">102</a> <em class="jxr_comment">// ensure that all parameters are documented</em>
-<a name="103" href="#103">103</a> <strong class="jxr_keyword">if</strong> ( params != <strong class="jxr_keyword">null</strong> && !params.isEmpty() )
-<a name="104" href="#104">104</a> {
-<a name="105" href="#105">105</a> <strong class="jxr_keyword">for</strong> ( Iterator paramIterator = params.iterator(); paramIterator.hasNext(); )
-<a name="106" href="#106">106</a> {
-<a name="107" href="#107">107</a> Parameter param = (Parameter) paramIterator.next();
-<a name="108" href="#108">108</a>
-<a name="109" href="#109">109</a> <strong class="jxr_keyword">if</strong> ( param.getRequirement() == <strong class="jxr_keyword">null</strong> && param.isEditable() )
-<a name="110" href="#110">110</a> {
-<a name="111" href="#111">111</a> String paramDescription = param.getDescription();
-<a name="112" href="#112">112</a>
-<a name="113" href="#113">113</a> <strong class="jxr_keyword">if</strong> ( paramDescription == <strong class="jxr_keyword">null</strong>
-<a name="114" href="#114">114</a> || paramDescription.trim().length() < MIN_DESCRIPTION_LENGTH )
-<a name="115" href="#115">115</a> {
-<a name="116" href="#116">116</a> reporter.error( <span class="jxr_string">"Parameter: \'"</span> + param.getName() + <span class="jxr_string">"\' in mojo: \'"</span>
-<a name="117" href="#117">117</a> + mojo.getGoal() + <span class="jxr_string">"\' is missing a description."</span> );
-<a name="118" href="#118">118</a> }
-<a name="119" href="#119">119</a> }
-<a name="120" href="#120">120</a> }
-<a name="121" href="#121">121</a> }
-<a name="122" href="#122">122</a> }
-<a name="123" href="#123">123</a> }
-<a name="124" href="#124">124</a> }
-<a name="125" href="#125">125</a>
-<a name="126" href="#126">126</a> checkConfiguredReportPlugins( project, reporter );
-<a name="127" href="#127">127</a>
-<a name="128" href="#128">128</a> checkProjectSite( project, reporter );
-<a name="129" href="#129">129</a> }
-<a name="130" href="#130">130</a>
-<a name="131" href="#131">131</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> approveProjectPackaging( String packaging )
-<a name="132" href="#132">132</a> {
-<a name="133" href="#133">133</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"maven-plugin"</span>.equals( packaging );
-<a name="134" href="#134">134</a> }
-<a name="135" href="#135">135</a>
-<a name="136" href="#136">136</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkProjectSite( MavenProject project, DocumentationReporter reporter )
-<a name="137" href="#137">137</a> {
-<a name="138" href="#138">138</a> File projectSiteDirectory = <strong class="jxr_keyword">new</strong> File( project.getBasedir(), siteDirectory );
-<a name="139" href="#139">139</a>
-<a name="140" href="#140">140</a> <em class="jxr_comment">// check for site.xml</em>
-<a name="141" href="#141">141</a> File siteXml = <strong class="jxr_keyword">new</strong> File( projectSiteDirectory, <span class="jxr_string">"site.xml"</span> );
-<a name="142" href="#142">142</a>
-<a name="143" href="#143">143</a> <strong class="jxr_keyword">if</strong> ( !siteXml.exists() )
-<a name="144" href="#144">144</a> {
-<a name="145" href="#145">145</a> reporter.error( <span class="jxr_string">"site.xml is missing."</span> );
-<a name="146" href="#146">146</a> }
-<a name="147" href="#147">147</a> <strong class="jxr_keyword">else</strong>
-<a name="148" href="#148">148</a> {
-<a name="149" href="#149">149</a> Reader streamReader = <strong class="jxr_keyword">null</strong>;
-<a name="150" href="#150">150</a> <strong class="jxr_keyword">try</strong>
-<a name="151" href="#151">151</a> {
-<a name="152" href="#152">152</a> streamReader = ReaderFactory.newXmlReader( siteXml );
-<a name="153" href="#153">153</a>
-<a name="154" href="#154">154</a> String siteHtml = IOUtil.toString( streamReader );
-<a name="155" href="#155">155</a>
-<a name="156" href="#156">156</a> <strong class="jxr_keyword">if</strong> ( siteHtml.indexOf( <span class="jxr_string">"href=\"index.html\""</span> ) < 0 )
-<a name="157" href="#157">157</a> {
-<a name="158" href="#158">158</a> reporter.error( <span class="jxr_string">"site.xml is missing the link to: index.html \"Introduction\"."</span> );
-<a name="159" href="#159">159</a> }
-<a name="160" href="#160">160</a>
-<a name="161" href="#161">161</a> <strong class="jxr_keyword">if</strong> ( siteHtml.indexOf( <span class="jxr_string">"href=\"usage.html\""</span> ) < 0 )
-<a name="162" href="#162">162</a> {
-<a name="163" href="#163">163</a> reporter.error( <span class="jxr_string">"site.xml is missing the link to: usage.html \"Usage\"."</span> );
-<a name="164" href="#164">164</a> }
-<a name="165" href="#165">165</a>
-<a name="166" href="#166">166</a> <strong class="jxr_keyword">if</strong> ( siteHtml.indexOf( <span class="jxr_string">"href=\"plugin-info.html\""</span> ) < 0 )
-<a name="167" href="#167">167</a> {
-<a name="168" href="#168">168</a> reporter.error( <span class="jxr_string">"site.xml is missing the link to: plugin-info.html \"Goals\"."</span> );
-<a name="169" href="#169">169</a> }
-<a name="170" href="#170">170</a>
-<a name="171" href="#171">171</a> <strong class="jxr_keyword">if</strong> ( siteHtml.indexOf( <span class="jxr_string">"href=\"faq.html\""</span> ) < 0 )
-<a name="172" href="#172">172</a> {
-<a name="173" href="#173">173</a> reporter.error( <span class="jxr_string">"site.xml is missing the link to: faq.html \"FAQ\"."</span> );
-<a name="174" href="#174">174</a> }
-<a name="175" href="#175">175</a> }
-<a name="176" href="#176">176</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
-<a name="177" href="#177">177</a> {
-<a name="178" href="#178">178</a> reporter.error( <span class="jxr_string">"Unable to read site.xml file: \'"</span> + siteXml.getAbsolutePath()
-<a name="179" href="#179">179</a> + <span class="jxr_string">"\'.\nError: "</span> + e.getMessage() );
-<a name="180" href="#180">180</a> }
-<a name="181" href="#181">181</a> <strong class="jxr_keyword">finally</strong>
-<a name="182" href="#182">182</a> {
-<a name="183" href="#183">183</a> IOUtil.close( streamReader );
-<a name="184" href="#184">184</a> }
-<a name="185" href="#185">185</a> }
-<a name="186" href="#186">186</a>
-<a name="187" href="#187">187</a> <em class="jxr_comment">// check for index.(apt|html|xml)[.vm]</em>
-<a name="188" href="#188">188</a> <strong class="jxr_keyword">if</strong> ( !findFiles( projectSiteDirectory, <span class="jxr_string">"index"</span> ) )
-<a name="189" href="#189">189</a> {
-<a name="190" href="#190">190</a> reporter.error( <span class="jxr_string">"There is no \'index\' file in your site directory (in apt|html|xml[.vm] format)."</span> );
-<a name="191" href="#191">191</a> }
-<a name="192" href="#192">192</a>
-<a name="193" href="#193">193</a> <em class="jxr_comment">// check for usage.(apt|html|xml)[.vm]</em>
-<a name="194" href="#194">194</a> <strong class="jxr_keyword">if</strong> ( !findFiles( projectSiteDirectory, <span class="jxr_string">"usage"</span> ) )
-<a name="195" href="#195">195</a> {
-<a name="196" href="#196">196</a> reporter.error( <span class="jxr_string">"There is no \'usage\' file in your site directory (in apt|html|xml[.vm] format)."</span> );
-<a name="197" href="#197">197</a> }
-<a name="198" href="#198">198</a>
-<a name="199" href="#199">199</a> <em class="jxr_comment">// check for **/examples</em><em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment">.(apt|html|xml)[.vm] or **/</em>example*.(apt|html|xml)[.vm]
-<a name="200" href="#200">200</a> <strong class="jxr_keyword">if</strong> ( !findFiles( projectSiteDirectory, <span class="jxr_string">"**/examples/*"</span> )
-<a name="201" href="#201">201</a> && !findFiles( projectSiteDirectory, <span class="jxr_string">"**/example*"</span> ) )
-<a name="202" href="#202">202</a> {
-<a name="203" href="#203">203</a> reporter.error( <span class="jxr_string">"There are no example files in your site directory (in apt|html|xml[.vm] format)."</span>
-<a name="204" href="#204">204</a> + <span class="jxr_string">" They should either be called \'example*.(apt|html|xml)[.vm]\'"</span>
-<a name="205" href="#205">205</a> + <span class="jxr_string">" or they should be located in the \'examples\' directory."</span> );
-<a name="206" href="#206">206</a> }
-<a name="207" href="#207">207</a>
-<a name="208" href="#208">208</a> <strong class="jxr_keyword">if</strong> ( !findFiles( projectSiteDirectory, <span class="jxr_string">"faq"</span> ) )
-<a name="209" href="#209">209</a> {
-<a name="210" href="#210">210</a> reporter.error( <span class="jxr_string">"There is no \'faq\' file in your site directory (in apt|fml|html|xml[.vm] format)."</span> );
-<a name="211" href="#211">211</a> }
-<a name="212" href="#212">212</a> }
-<a name="213" href="#213">213</a>
-<a name="214" href="#214">214</a> <em class="jxr_javadoccomment">/**</em>
-<a name="215" href="#215">215</a> <em class="jxr_javadoccomment"> * Checks the project configured plugins if the required report plugins are present.</em>
-<a name="216" href="#216">216</a> <em class="jxr_javadoccomment"> *</em>
-<a name="217" href="#217">217</a> <em class="jxr_javadoccomment"> * @param project MavenProject to check</em>
-<a name="218" href="#218">218</a> <em class="jxr_javadoccomment"> * @param reporter listener</em>
-<a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * @todo maybe this should be checked default for all project?</em>
-<a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> */</em>
-<a name="221" href="#221">221</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkConfiguredReportPlugins( MavenProject project, DocumentationReporter reporter )
-<a name="222" href="#222">222</a> {
-<a name="223" href="#223">223</a> List expectedPlugins = getRequiredPlugins();
-<a name="224" href="#224">224</a>
-<a name="225" href="#225">225</a> List reportPlugins = project.getReportPlugins();
-<a name="226" href="#226">226</a> <strong class="jxr_keyword">if</strong> ( reportPlugins != <strong class="jxr_keyword">null</strong> && reportPlugins.size() > 0 )
-<a name="227" href="#227">227</a> {
-<a name="228" href="#228">228</a> <strong class="jxr_keyword">for</strong> ( Iterator plugins = reportPlugins.iterator(); plugins.hasNext(); )
-<a name="229" href="#229">229</a> {
-<a name="230" href="#230">230</a> ReportPlugin plugin = (ReportPlugin) plugins.next();
-<a name="231" href="#231">231</a>
-<a name="232" href="#232">232</a> expectedPlugins.remove( plugin.getArtifactId() );
-<a name="233" href="#233">233</a> }
-<a name="234" href="#234">234</a> }
-<a name="235" href="#235">235</a> <strong class="jxr_keyword">else</strong>
-<a name="236" href="#236">236</a> {
-<a name="237" href="#237">237</a> reporter.error( <span class="jxr_string">"pom.xml has no report plugins configured."</span> );
-<a name="238" href="#238">238</a> }
-<a name="239" href="#239">239</a>
-<a name="240" href="#240">240</a> <strong class="jxr_keyword">for</strong> ( Iterator plugins = expectedPlugins.iterator(); plugins.hasNext(); )
-<a name="241" href="#241">241</a> {
-<a name="242" href="#242">242</a> reporter.error( <span class="jxr_string">"pom.xml is missing the report plugin: "</span> + plugins.next().toString() + <span class="jxr_string">"."</span> );
-<a name="243" href="#243">243</a> }
-<a name="244" href="#244">244</a> }
-<a name="245" href="#245">245</a>
-<a name="246" href="#246">246</a> <em class="jxr_javadoccomment">/**</em>
-<a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * Returns a List of Strings of required report plugins.</em>
-<a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> *</em>
-<a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> * @return List of report plugin artifactIds</em>
-<a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> */</em>
-<a name="251" href="#251">251</a> <strong class="jxr_keyword">private</strong> List getRequiredPlugins()
-<a name="252" href="#252">252</a> {
-<a name="253" href="#253">253</a> List list = <strong class="jxr_keyword">new</strong> ArrayList();
-<a name="254" href="#254">254</a>
-<a name="255" href="#255">255</a> list.add( <span class="jxr_string">"maven-javadoc-plugin"</span> );
-<a name="256" href="#256">256</a> list.add( <span class="jxr_string">"maven-jxr-plugin"</span> );
-<a name="257" href="#257">257</a>
-<a name="258" href="#258">258</a> <strong class="jxr_keyword">return</strong> list;
-<a name="259" href="#259">259</a> }
-<a name="260" href="#260">260</a> }
+<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.docck;
+<a class="jxr_linenumber" name="L2" href="#L2">2</a>
+<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
+<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
+<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
+<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
+<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em>
+<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="L21" href="#L21">21</a>
+<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.model.ReportPlugin;
+<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException;
+<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.MojoDescriptor;
+<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.Parameter;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.descriptor.PluginDescriptor;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.docck.reports.DocumentationReporter;
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Component;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.LifecyclePhase;
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.tools.plugin.extractor.ExtractionException;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.tools.plugin.scanner.MojoScanner;
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.IOUtil;
+<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.ReaderFactory;
+<a class="jxr_linenumber" name="L36" href="#L36">36</a>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> java.io.File;
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> java.io.Reader;
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="L42" href="#L42">42</a>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * Checks a plugin's documentation for the standard minimums.</em>
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @author jdcasey</em>
+<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> @Mojo( name = <span class="jxr_string">"check"</span>, aggregator = <strong class="jxr_keyword">true</strong>, defaultPhase = LifecyclePhase.VALIDATE, threadSafe = <strong class="jxr_keyword">true</strong> )
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.html">CheckPluginDocumentationMojo</a>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugin/docck/AbstractCheckDocumentationMojo.html">AbstractCheckDocumentationMojo</a>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> {
+<a class="jxr_linenumber" name="L52" href="#L52">52</a>
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * Plexus component that searches for Mojos.</em>
+<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> @Component
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">protected</strong> MojoScanner mojoScanner;
+<a class="jxr_linenumber" name="L58" href="#L58">58</a>
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_comment">// TODO: really a description of length 1 isn't all that helpful...</em>
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MIN_DESCRIPTION_LENGTH = 1;
+<a class="jxr_linenumber" name="L61" href="#L61">61</a>
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> checkPackagingSpecificDocumentation( MavenProject project, DocumentationReporter reporter )
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> {
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> PluginDescriptor descriptor = <strong class="jxr_keyword">new</strong> PluginDescriptor();
+<a class="jxr_linenumber" name="L65" href="#L65">65</a>
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> {
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> mojoScanner.populatePluginDescriptor( project, descriptor );
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">catch</strong> ( InvalidPluginDescriptorException e )
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> {
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> reporter.error( <span class="jxr_string">"Failed to parse mojo descriptors.\nError: "</span> + e.getMessage() );
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> descriptor = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> }
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">catch</strong> ( ExtractionException e )
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> {
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> reporter.error( <span class="jxr_string">"Failed to parse mojo descriptors.\nError: "</span> + e.getMessage() );
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> descriptor = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
+<a class="jxr_linenumber" name="L80" href="#L80">80</a>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">if</strong> ( descriptor != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> {
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> )
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> List<MojoDescriptor> mojos = descriptor.getMojos();
+<a class="jxr_linenumber" name="L85" href="#L85">85</a>
+<a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_comment">// ensure that all mojo classes are documented</em>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">if</strong> ( mojos != <strong class="jxr_keyword">null</strong> && !mojos.isEmpty() )
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> {
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">for</strong> ( MojoDescriptor mojo : mojos )
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> {
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> String mojoDescription = mojo.getDescription();
+<a class="jxr_linenumber" name="L92" href="#L92">92</a>
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">if</strong> ( mojoDescription == <strong class="jxr_keyword">null</strong> || mojoDescription.trim().length() < MIN_DESCRIPTION_LENGTH )
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> {
+<a class="jxr_linenumber" name="L95" href="#L95">95</a> reporter.error( <span class="jxr_string">"Mojo: \'"</span> + mojo.getGoal() + <span class="jxr_string">"\' is missing a description."</span> );
+<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
+<a class="jxr_linenumber" name="L97" href="#L97">97</a>
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> )
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> List<Parameter> params = mojo.getParameters();
+<a class="jxr_linenumber" name="L100" href="#L100">100</a>
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_comment">// ensure that all parameters are documented</em>
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">if</strong> ( params != <strong class="jxr_keyword">null</strong> && !params.isEmpty() )
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> {
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">for</strong> ( Parameter param : params )
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> {
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">if</strong> ( param.getRequirement() == <strong class="jxr_keyword">null</strong> && param.isEditable() )
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> {
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> String paramDescription = param.getDescription();
+<a class="jxr_linenumber" name="L109" href="#L109">109</a>
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">if</strong> ( paramDescription == <strong class="jxr_keyword">null</strong>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> || paramDescription.trim().length() < MIN_DESCRIPTION_LENGTH )
+<a class="jxr_linenumber" name="L112" href="#L112">112</a> {
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> reporter.error( <span class="jxr_string">"Parameter: \'"</span> + param.getName() + <span class="jxr_string">"\' in mojo: \'"</span>
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> + mojo.getGoal() + <span class="jxr_string">"\' is missing a description."</span> );
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
+<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
+<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
+<a class="jxr_linenumber" name="L119" href="#L119">119</a> }
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> }
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> }
+<a class="jxr_linenumber" name="L122" href="#L122">122</a>
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> checkConfiguredReportPlugins( project, reporter );
+<a class="jxr_linenumber" name="L124" href="#L124">124</a>
+<a class="jxr_linenumber" name="L125" href="#L125">125</a> checkProjectSite( project, reporter );
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> }
+<a class="jxr_linenumber" name="L127" href="#L127">127</a>
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> approveProjectPackaging( String packaging )
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> {
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"maven-plugin"</span>.equals( packaging );
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> }
+<a class="jxr_linenumber" name="L132" href="#L132">132</a>
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkProjectSite( MavenProject project, DocumentationReporter reporter )
+<a class="jxr_linenumber" name="L134" href="#L134">134</a> {
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> File projectSiteDirectory = <strong class="jxr_keyword">new</strong> File( project.getBasedir(), siteDirectory );
+<a class="jxr_linenumber" name="L136" href="#L136">136</a>
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_comment">// check for site.xml</em>
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> File siteXml = <strong class="jxr_keyword">new</strong> File( projectSiteDirectory, <span class="jxr_string">"site.xml"</span> );
+<a class="jxr_linenumber" name="L139" href="#L139">139</a>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">if</strong> ( !siteXml.exists() )
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> {
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> reporter.error( <span class="jxr_string">"site.xml is missing."</span> );
+<a class="jxr_linenumber" name="L143" href="#L143">143</a> }
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> {
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> Reader streamReader = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> {
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> streamReader = ReaderFactory.newXmlReader( siteXml );
+<a class="jxr_linenumber" name="L150" href="#L150">150</a>
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> String siteHtml = IOUtil.toString( streamReader );
+<a class="jxr_linenumber" name="L152" href="#L152">152</a>
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">if</strong> ( !siteHtml.contains( <span class="jxr_string">"href=\"index.html\""</span> ) )
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> {
+<a class="jxr_linenumber" name="L155" href="#L155">155</a> reporter.error( <span class="jxr_string">"site.xml is missing the link to: index.html \"Introduction\"."</span> );
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> }
+<a class="jxr_linenumber" name="L157" href="#L157">157</a>
+<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">if</strong> ( !siteHtml.contains( <span class="jxr_string">"href=\"usage.html\""</span> ) )
+<a class="jxr_linenumber" name="L159" href="#L159">159</a> {
+<a class="jxr_linenumber" name="L160" href="#L160">160</a> reporter.error( <span class="jxr_string">"site.xml is missing the link to: usage.html \"Usage\"."</span> );
+<a class="jxr_linenumber" name="L161" href="#L161">161</a> }
+<a class="jxr_linenumber" name="L162" href="#L162">162</a>
+<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">if</strong> ( !siteHtml.contains( <span class="jxr_string">"href=\"plugin-info.html\""</span> ) )
+<a class="jxr_linenumber" name="L164" href="#L164">164</a> {
+<a class="jxr_linenumber" name="L165" href="#L165">165</a> reporter.error( <span class="jxr_string">"site.xml is missing the link to: plugin-info.html \"Goals\"."</span> );
+<a class="jxr_linenumber" name="L166" href="#L166">166</a> }
+<a class="jxr_linenumber" name="L167" href="#L167">167</a>
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">if</strong> ( !siteHtml.contains( <span class="jxr_string">"href=\"faq.html\""</span> ) )
+<a class="jxr_linenumber" name="L169" href="#L169">169</a> {
+<a class="jxr_linenumber" name="L170" href="#L170">170</a> reporter.error( <span class="jxr_string">"site.xml is missing the link to: faq.html \"FAQ\"."</span> );
+<a class="jxr_linenumber" name="L171" href="#L171">171</a> }
+<a class="jxr_linenumber" name="L172" href="#L172">172</a> }
+<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">catch</strong> ( IOException e )
+<a class="jxr_linenumber" name="L174" href="#L174">174</a> {
+<a class="jxr_linenumber" name="L175" href="#L175">175</a> reporter.error( <span class="jxr_string">"Unable to read site.xml file: \'"</span> + siteXml.getAbsolutePath() + <span class="jxr_string">"\'.\nError: "</span>
+<a class="jxr_linenumber" name="L176" href="#L176">176</a> + e.getMessage() );
+<a class="jxr_linenumber" name="L177" href="#L177">177</a> }
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">finally</strong>
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> {
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> IOUtil.close( streamReader );
+<a class="jxr_linenumber" name="L181" href="#L181">181</a> }
+<a class="jxr_linenumber" name="L182" href="#L182">182</a> }
+<a class="jxr_linenumber" name="L183" href="#L183">183</a>
+<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em class="jxr_comment">// check for index.(apt|html|xml)[.vm]</em>
+<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">if</strong> ( !findFiles( projectSiteDirectory, <span class="jxr_string">"index"</span> ) )
+<a class="jxr_linenumber" name="L186" href="#L186">186</a> {
+<a class="jxr_linenumber" name="L187" href="#L187">187</a> reporter.error( <span class="jxr_string">"There is no \'index\' file in your site directory (in apt|html|xml[.vm] format)."</span> );
+<a class="jxr_linenumber" name="L188" href="#L188">188</a> }
+<a class="jxr_linenumber" name="L189" href="#L189">189</a>
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em class="jxr_comment">// check for usage.(apt|html|xml)[.vm]</em>
+<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">if</strong> ( !findFiles( projectSiteDirectory, <span class="jxr_string">"usage"</span> ) )
+<a class="jxr_linenumber" name="L192" href="#L192">192</a> {
+<a class="jxr_linenumber" name="L193" href="#L193">193</a> reporter.error( <span class="jxr_string">"There is no \'usage\' file in your site directory (in apt|html|xml[.vm] format)."</span> );
+<a class="jxr_linenumber" name="L194" href="#L194">194</a> }
+<a class="jxr_linenumber" name="L195" href="#L195">195</a>
+<a class="jxr_linenumber" name="L196" href="#L196">196</a> <em class="jxr_comment">// check for **/examples/**.(apt|html|xml)[.vm] or **/example*.(apt|html|xml)[.vm]</em>
+<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">if</strong> ( !findFiles( projectSiteDirectory, <span class="jxr_string">"**/examples/*"</span> ) && !findFiles( projectSiteDirectory, <span class="jxr_string">"**/example*"</span> ) )
+<a class="jxr_linenumber" name="L198" href="#L198">198</a> {
+<a class="jxr_linenumber" name="L199" href="#L199">199</a> reporter.error( <span class="jxr_string">"There are no example files in your site directory (in apt|html|xml[.vm] format)."</span>
+<a class="jxr_linenumber" name="L200" href="#L200">200</a> + <span class="jxr_string">" They should either be called \'example*.(apt|html|xml)[.vm]\'"</span>
+<a class="jxr_linenumber" name="L201" href="#L201">201</a> + <span class="jxr_string">" or they should be located in the \'examples\' directory."</span> );
+<a class="jxr_linenumber" name="L202" href="#L202">202</a> }
+<a class="jxr_linenumber" name="L203" href="#L203">203</a>
+<a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">if</strong> ( !findFiles( projectSiteDirectory, <span class="jxr_string">"faq"</span> ) )
+<a class="jxr_linenumber" name="L205" href="#L205">205</a> {
+<a class="jxr_linenumber" name="L206" href="#L206">206</a> reporter.error( <span class="jxr_string">"There is no \'faq\' file in your site directory (in apt|fml|html|xml[.vm] format)."</span> );
+<a class="jxr_linenumber" name="L207" href="#L207">207</a> }
+<a class="jxr_linenumber" name="L208" href="#L208">208</a> }
+<a class="jxr_linenumber" name="L209" href="#L209">209</a>
+<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * Checks the project configured plugins if the required report plugins are present.</em>
+<a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @param project MavenProject to check</em>
+<a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> * @param reporter listener</em>
+<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em class="jxr_javadoccomment"> * @todo maybe this should be checked default for all project?</em>
+<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L217" href="#L217">217</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkConfiguredReportPlugins( MavenProject project, DocumentationReporter reporter )
+<a class="jxr_linenumber" name="L218" href="#L218">218</a> {
+<a class="jxr_linenumber" name="L219" href="#L219">219</a> List<String> expectedPlugins = getRequiredPlugins();
+<a class="jxr_linenumber" name="L220" href="#L220">220</a>
+<a class="jxr_linenumber" name="L221" href="#L221">221</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> )
+<a class="jxr_linenumber" name="L222" href="#L222">222</a> List<ReportPlugin> reportPlugins = project.getReportPlugins();
+<a class="jxr_linenumber" name="L223" href="#L223">223</a> <strong class="jxr_keyword">if</strong> ( reportPlugins != <strong class="jxr_keyword">null</strong> && reportPlugins.size() > 0 )
+<a class="jxr_linenumber" name="L224" href="#L224">224</a> {
+<a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">for</strong> ( ReportPlugin plugin : reportPlugins )
+<a class="jxr_linenumber" name="L226" href="#L226">226</a> {
+<a class="jxr_linenumber" name="L227" href="#L227">227</a> expectedPlugins.remove( plugin.getArtifactId() );
+<a class="jxr_linenumber" name="L228" href="#L228">228</a> }
+<a class="jxr_linenumber" name="L229" href="#L229">229</a> }
+<a class="jxr_linenumber" name="L230" href="#L230">230</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="L231" href="#L231">231</a> {
+<a class="jxr_linenumber" name="L232" href="#L232">232</a> reporter.error( <span class="jxr_string">"pom.xml has no report plugins configured."</span> );
+<a class="jxr_linenumber" name="L233" href="#L233">233</a> }
+<a class="jxr_linenumber" name="L234" href="#L234">234</a>
+<a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">for</strong> ( String expectedPlugin : expectedPlugins )
+<a class="jxr_linenumber" name="L236" href="#L236">236</a> {
+<a class="jxr_linenumber" name="L237" href="#L237">237</a> reporter.error( <span class="jxr_string">"pom.xml is missing the report plugin: "</span> + expectedPlugin + <span class="jxr_string">"."</span> );
+<a class="jxr_linenumber" name="L238" href="#L238">238</a> }
+<a class="jxr_linenumber" name="L239" href="#L239">239</a> }
+<a class="jxr_linenumber" name="L240" href="#L240">240</a>
+<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * Returns a List of Strings of required report plugins.</em>
+<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * @return List of report plugin artifactIds</em>
+<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L246" href="#L246">246</a> <strong class="jxr_keyword">private</strong> List<String> getRequiredPlugins()
+<a class="jxr_linenumber" name="L247" href="#L247">247</a> {
+<a class="jxr_linenumber" name="L248" href="#L248">248</a> List<String> list = <strong class="jxr_keyword">new</strong> ArrayList<String>();
+<a class="jxr_linenumber" name="L249" href="#L249">249</a>
+<a class="jxr_linenumber" name="L250" href="#L250">250</a> list.add( <span class="jxr_string">"maven-javadoc-plugin"</span> );
+<a class="jxr_linenumber" name="L251" href="#L251">251</a> list.add( <span class="jxr_string">"maven-jxr-plugin"</span> );
+<a class="jxr_linenumber" name="L252" href="#L252">252</a>
+<a class="jxr_linenumber" name="L253" href="#L253">253</a> <strong class="jxr_keyword">return</strong> list;
+<a class="jxr_linenumber" name="L254" href="#L254">254</a> }
+<a class="jxr_linenumber" name="L255" href="#L255">255</a> }
</pre>
-<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
-</html>
-
+<hr/>
+<div id="footer">Copyright © 2002–2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
+</body>
+</html>
\ No newline at end of file