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 sj...@apache.org on 2023/10/22 12:56:58 UTC
svn commit: r1913202 [17/19] - in /maven/website/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/reports/ a...
Modified: maven/website/components/plugins-archives/maven-docck-plugin-LATEST/xref/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.html
==============================================================================
--- maven/website/components/plugins-archives/maven-docck-plugin-LATEST/xref/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.html (original)
+++ maven/website/components/plugins-archives/maven-docck-plugin-LATEST/xref/org/apache/maven/plugin/docck/CheckPluginDocumentationMojo.html Sun Oct 22 12:56:56 2023
@@ -67,95 +67,95 @@
<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="L62" href="#L62">62</a> @Override
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> checkPackagingSpecificDocumentation( MavenProject project, DocumentationReporter reporter )
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> {
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> PluginDescriptor descriptor = <strong class="jxr_keyword">new</strong> PluginDescriptor();
+<a class="jxr_linenumber" name="L66" href="#L66">66</a>
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="L68" href="#L68">68</a> {
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> mojoScanner.populatePluginDescriptor( project, descriptor );
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> }
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">catch</strong> ( InvalidPluginDescriptorException e )
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> {
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> reporter.error( <span class="jxr_string">"Failed to parse mojo descriptors.\nError: "</span> + e.getMessage() );
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> descriptor = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> }
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">catch</strong> ( ExtractionException e )
+<a class="jxr_linenumber" name="L77" href="#L77">77</a> {
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> reporter.error( <span class="jxr_string">"Failed to parse mojo descriptors.\nError: "</span> + e.getMessage() );
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> descriptor = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L80" href="#L80">80</a> }
+<a class="jxr_linenumber" name="L81" href="#L81">81</a>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">if</strong> ( descriptor != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> {
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> )
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> List<MojoDescriptor> mojos = descriptor.getMojos();
+<a class="jxr_linenumber" name="L86" href="#L86">86</a>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_comment">// ensure that all mojo classes are documented</em>
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">if</strong> ( mojos != <strong class="jxr_keyword">null</strong> && !mojos.isEmpty() )
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> {
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">for</strong> ( MojoDescriptor mojo : mojos )
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> {
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> String mojoDescription = mojo.getDescription();
+<a class="jxr_linenumber" name="L93" href="#L93">93</a>
+<a class="jxr_linenumber" name="L94" href="#L94">94</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="L95" href="#L95">95</a> {
+<a class="jxr_linenumber" name="L96" href="#L96">96</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="L97" href="#L97">97</a> }
+<a class="jxr_linenumber" name="L98" href="#L98">98</a>
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> )
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> List<Parameter> params = mojo.getParameters();
+<a class="jxr_linenumber" name="L101" href="#L101">101</a>
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_comment">// ensure that all parameters are documented</em>
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">if</strong> ( params != <strong class="jxr_keyword">null</strong> && !params.isEmpty() )
+<a class="jxr_linenumber" name="L104" href="#L104">104</a> {
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">for</strong> ( Parameter param : params )
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> {
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">if</strong> ( param.getRequirement() == <strong class="jxr_keyword">null</strong> && param.isEditable() )
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> {
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> String paramDescription = param.getDescription();
+<a class="jxr_linenumber" name="L110" href="#L110">110</a>
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">if</strong> ( paramDescription == <strong class="jxr_keyword">null</strong>
+<a class="jxr_linenumber" name="L112" href="#L112">112</a> || paramDescription.trim().length() < MIN_DESCRIPTION_LENGTH )
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> {
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> reporter.error( <span class="jxr_string">"Parameter: \'"</span> + param.getName() + <span class="jxr_string">"\' in mojo: \'"</span>
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> + mojo.getGoal() + <span class="jxr_string">"\' is missing a description."</span> );
+<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>
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> checkConfiguredReportPlugins( project, reporter );
+<a class="jxr_linenumber" name="L125" href="#L125">125</a>
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> checkProjectSite( project, reporter );
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> }
+<a class="jxr_linenumber" name="L128" href="#L128">128</a>
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> @Override
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">boolean</strong> approveProjectPackaging( String packaging )
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> {
+<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"maven-plugin"</span>.equals( packaging );
+<a class="jxr_linenumber" name="L133" href="#L133">133</a> }
+<a class="jxr_linenumber" name="L134" href="#L134">134</a>
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkProjectSite( MavenProject project, DocumentationReporter reporter )
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> {
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> File projectSiteDirectory = <strong class="jxr_keyword">new</strong> File( project.getBasedir(), siteDirectory );
+<a class="jxr_linenumber" name="L138" href="#L138">138</a>
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_comment">// check for site.xml</em>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> File siteXml = <strong class="jxr_keyword">new</strong> File( projectSiteDirectory, <span class="jxr_string">"site.xml"</span> );
+<a class="jxr_linenumber" name="L141" href="#L141">141</a>
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">if</strong> ( !siteXml.exists() )
+<a class="jxr_linenumber" name="L143" href="#L143">143</a> {
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> reporter.error( <span class="jxr_string">"site.xml is missing."</span> );
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> }
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> {
+<a class="jxr_linenumber" name="L148" href="#L148">148</a>
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">try</strong> ( Reader 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> ) )
@@ -183,86 +183,82 @@
<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="L178" href="#L178">178</a> }
+<a class="jxr_linenumber" name="L179" href="#L179">179</a>
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_comment">// check for index.(apt|html|xml)[.vm]</em>
+<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">if</strong> ( !findFiles( projectSiteDirectory, <span class="jxr_string">"index"</span> ) )
+<a class="jxr_linenumber" name="L182" href="#L182">182</a> {
+<a class="jxr_linenumber" name="L183" href="#L183">183</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="L184" href="#L184">184</a> }
+<a class="jxr_linenumber" name="L185" href="#L185">185</a>
+<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em class="jxr_comment">// check for usage.(apt|html|xml)[.vm]</em>
+<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">if</strong> ( !findFiles( projectSiteDirectory, <span class="jxr_string">"usage"</span> ) )
+<a class="jxr_linenumber" name="L188" href="#L188">188</a> {
+<a class="jxr_linenumber" name="L189" href="#L189">189</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="L190" href="#L190">190</a> }
+<a class="jxr_linenumber" name="L191" href="#L191">191</a>
+<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em class="jxr_comment">// check for **/examples/**.(apt|html|xml)[.vm] or **/example*.(apt|html|xml)[.vm]</em>
+<a class="jxr_linenumber" name="L193" href="#L193">193</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="L194" href="#L194">194</a> {
+<a class="jxr_linenumber" name="L195" href="#L195">195</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="L196" href="#L196">196</a> + <span class="jxr_string">" They should either be called \'example*.(apt|html|xml)[.vm]\'"</span>
+<a class="jxr_linenumber" name="L197" href="#L197">197</a> + <span class="jxr_string">" or they should be located in the \'examples\' directory."</span> );
+<a class="jxr_linenumber" name="L198" href="#L198">198</a> }
+<a class="jxr_linenumber" name="L199" href="#L199">199</a>
+<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">if</strong> ( !findFiles( projectSiteDirectory, <span class="jxr_string">"faq"</span> ) )
+<a class="jxr_linenumber" name="L201" href="#L201">201</a> {
+<a class="jxr_linenumber" name="L202" href="#L202">202</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="L203" href="#L203">203</a> }
+<a class="jxr_linenumber" name="L204" href="#L204">204</a> }
+<a class="jxr_linenumber" name="L205" href="#L205">205</a>
+<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * Checks the project configured plugins if the required report plugins are present.</em>
+<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * @param project MavenProject to check</em>
+<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * @param reporter listener</em>
+<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * @todo maybe this should be checked default for all project?</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> checkConfiguredReportPlugins( MavenProject project, DocumentationReporter reporter )
+<a class="jxr_linenumber" name="L214" href="#L214">214</a> {
+<a class="jxr_linenumber" name="L215" href="#L215">215</a> List<String> expectedPlugins = getRequiredPlugins();
+<a class="jxr_linenumber" name="L216" href="#L216">216</a>
+<a class="jxr_linenumber" name="L217" href="#L217">217</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> )
+<a class="jxr_linenumber" name="L218" href="#L218">218</a> List<ReportPlugin> reportPlugins = project.getReportPlugins();
+<a class="jxr_linenumber" name="L219" href="#L219">219</a> <strong class="jxr_keyword">if</strong> ( reportPlugins != <strong class="jxr_keyword">null</strong> && reportPlugins.size() > 0 )
+<a class="jxr_linenumber" name="L220" href="#L220">220</a> {
+<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">for</strong> ( ReportPlugin plugin : reportPlugins )
+<a class="jxr_linenumber" name="L222" href="#L222">222</a> {
+<a class="jxr_linenumber" name="L223" href="#L223">223</a> expectedPlugins.remove( plugin.getArtifactId() );
+<a class="jxr_linenumber" name="L224" href="#L224">224</a> }
+<a class="jxr_linenumber" name="L225" href="#L225">225</a> }
+<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="L227" href="#L227">227</a> {
+<a class="jxr_linenumber" name="L228" href="#L228">228</a> reporter.error( <span class="jxr_string">"pom.xml has no report plugins configured."</span> );
<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> }
+<a class="jxr_linenumber" name="L230" href="#L230">230</a>
+<a class="jxr_linenumber" name="L231" href="#L231">231</a> <strong class="jxr_keyword">for</strong> ( String expectedPlugin : expectedPlugins )
+<a class="jxr_linenumber" name="L232" href="#L232">232</a> {
+<a class="jxr_linenumber" name="L233" href="#L233">233</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="L234" href="#L234">234</a> }
+<a class="jxr_linenumber" name="L235" href="#L235">235</a> }
+<a class="jxr_linenumber" name="L236" href="#L236">236</a>
+<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em class="jxr_javadoccomment"> * Returns a List of Strings of required report plugins.</em>
+<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * @return List of report plugin artifactIds</em>
+<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> <strong class="jxr_keyword">private</strong> List<String> getRequiredPlugins()
+<a class="jxr_linenumber" name="L243" href="#L243">243</a> {
+<a class="jxr_linenumber" name="L244" href="#L244">244</a> List<String> list = <strong class="jxr_keyword">new</strong> ArrayList<>();
+<a class="jxr_linenumber" name="L245" href="#L245">245</a>
+<a class="jxr_linenumber" name="L246" href="#L246">246</a> list.add( <span class="jxr_string">"maven-javadoc-plugin"</span> );
+<a class="jxr_linenumber" name="L247" href="#L247">247</a> list.add( <span class="jxr_string">"maven-jxr-plugin"</span> );
+<a class="jxr_linenumber" name="L248" href="#L248">248</a>
+<a class="jxr_linenumber" name="L249" href="#L249">249</a> <strong class="jxr_keyword">return</strong> list;
+<a class="jxr_linenumber" name="L250" href="#L250">250</a> }
+<a class="jxr_linenumber" name="L251" href="#L251">251</a> }
</pre>
<hr/>
-<div id="footer">Copyright © 2002–2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
+<div id="footer">Copyright © 2002–2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>
\ No newline at end of file