Modified: websites/production/maven/content/jxr-archives/jxr-LATEST/apidocs/org/apache/maven/plugin/jxr/JxrReportUtil.html ============================================================================== --- websites/production/maven/content/jxr-archives/jxr-LATEST/apidocs/org/apache/maven/plugin/jxr/JxrReportUtil.html (original) +++ websites/production/maven/content/jxr-archives/jxr-LATEST/apidocs/org/apache/maven/plugin/jxr/JxrReportUtil.html Sun Dec 8 21:59:46 2013 @@ -1,343 +1,343 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="fr"> -<head> -<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> -<title>JxrReportUtil (Maven JXR Parent 2.4-SNAPSHOT API)</title> -<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> -</head> -<body> -<script type="text/javascript"><!-- - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="JxrReportUtil (Maven JXR Parent 2.4-SNAPSHOT API)"; - } -//--> -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar_top"> -<!-- --> -</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/JxrReportUtil.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../../index-all.html">Index</a></li> -<li><a href="../../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../../org/apache/maven/plugin/jxr/JxrReport.html" title="class in org.apache.maven.plugin.jxr"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/maven/plugin/jxr/JxrTestReport.html" title="class in org.apache.maven.plugin.jxr"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/maven/plugin/jxr/JxrReportUtil.html" target="_top">Frames</a></li> -<li><a href="JxrReportUtil.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">org.apache.maven.plugin.jxr</div> -<h2 title="Class JxrReportUtil" class="title">Class JxrReportUtil</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> -<li> -<ul class="inheritance"> -<li>org.apache.maven.plugin.jxr.JxrReportUtil</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public class <span class="strong">JxrReportUtil</span> -extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> -<div class="block">Utility class for the jxr report.</div> -<dl><dt><span class="strong">Version:</span></dt> - <dd>$Id: JxrReportUtil.java 1145180 2011-07-11 14:02:55Z bimargulies $</dd> -<dt><span class="strong">Author:</span></dt> - <dd><a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</a></dd></dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><strong><a href="../../../../../org/apache/maven/plugin/jxr/JxrReportUtil.html#JxrReportUtil()">JxrReportUtil</a></strong>()</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span>Methods</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugin/jxr/JxrReportUtil.html#getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject, java.lang.String, java.lang.String)">getMavenJavadocPluginBasicOption</a></strong>(org.apache.maven.project.MavenProject project, - <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> optionName, - <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> defaultValue)</code> -<div class="block">Return the <code>optionName</code> value defined in a project for the "maven-javadoc-plugin" plugin.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugin/jxr/JxrReportUtil.html#getMavenJavadocPlugins(org.apache.maven.project.MavenProject)">getMavenJavadocPlugins</a></strong>(org.apache.maven.project.MavenProject project)</code> -<div class="block">Return the plugin references for the javadoc plugin in a project.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugin/jxr/JxrReportUtil.html#getStructure(org.apache.maven.project.MavenProject, boolean)">getStructure</a></strong>(org.apache.maven.project.MavenProject project, - boolean ignoreMissingSiteUrl)</code> -<div class="block">Generates the site structure using the project hierarchy (project and its modules) or using the - distributionManagement elements from the pom.xml.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>protected static boolean</code></td> -<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugin/jxr/JxrReportUtil.html#isJavadocAggregated(org.apache.maven.project.MavenProject)">isJavadocAggregated</a></strong>(org.apache.maven.project.MavenProject project)</code> -<div class="block">Determine if javadoc is aggregated in this project, paying attention to both - TODO: take cognizance of javadoc versus test-javadoc - the old parameter and the new mojo.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/jav ase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor_detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="JxrReportUtil()"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>JxrReportUtil</h4> -<pre>public JxrReportUtil()</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method_detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="isJavadocAggregated(org.apache.maven.project.MavenProject)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isJavadocAggregated</h4> -<pre>protected static boolean isJavadocAggregated(org.apache.maven.project.MavenProject project) - throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> -<div class="block">Determine if javadoc is aggregated in this project, paying attention to both - TODO: take cognizance of javadoc versus test-javadoc - the old parameter and the new mojo.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - </dd> -<dt><span class="strong">Returns:</span></dt><dd></dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> -</li> -</ul> -<a name="getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject, java.lang.String, java.lang.String)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMavenJavadocPluginBasicOption</h4> -<pre>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project, - <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> optionName, - <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> defaultValue) - throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> -<div class="block">Return the <code>optionName</code> value defined in a project for the "maven-javadoc-plugin" plugin.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - not null</dd><dd><code>optionName</code> - the option name wanted</dd><dd><code>defaultValue</code> - a default value</dd> -<dt><span class="strong">Returns:</span></dt><dd>the value for the option name or the default value. Could be null if not found.</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if any</dd></dl> -</li> -</ul> -<a name="getMavenJavadocPlugins(org.apache.maven.project.MavenProject)"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMavenJavadocPlugins</h4> -<pre>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> getMavenJavadocPlugins(org.apache.maven.project.MavenProject project) - throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> -<div class="block">Return the plugin references for the javadoc plugin in a project.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - not null</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if any</dd></dl> -</li> -</ul> -<a name="getStructure(org.apache.maven.project.MavenProject, boolean)"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getStructure</h4> -<pre>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getStructure(org.apache.maven.project.MavenProject project, - boolean ignoreMissingSiteUrl) - throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> -<div class="block">Generates the site structure using the project hierarchy (project and its modules) or using the - distributionManagement elements from the pom.xml.</div> -<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - </dd><dd><code>ignoreMissingSiteUrl</code> - </dd> -<dt><span class="strong">Returns:</span></dt><dd>the structure relative path</dd> -<dt><span class="strong">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if any</dd><dt><span class="strong">See Also:</span></dt><dd><code>org.apache.maven.plugins.site.SiteStageMojo#getStructure( MavenProject project, boolean ignoreMissingSiteUrl )</code></dd></dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar_bottom"> -<!-- --> -</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../../../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/JxrReportUtil.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../../../../index-all.html">Index</a></li> -<li><a href="../../../../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../../../../org/apache/maven/plugin/jxr/JxrReport.html" title="class in org.apache.maven.plugin.jxr"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/maven/plugin/jxr/JxrTestReport.html" title="class in org.apache.maven.plugin.jxr"><span class="strong">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../../../../index.html?org/apache/maven/plugin/jxr/JxrReportUtil.html" target="_top">Frames</a></li> -<li><a href="JxrReportUtil.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor_summary">Constr</a> | </li> -<li><a href="#method_summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor_detail">Constr</a> | </li> -<li><a href="#method_detail">Method</a></li> -</ul> -</div> -<a name="skip-navbar_bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -<p class="legalCopy"><small>Copyright © 2002-2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> -</body> +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="de"> +<head> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>JxrReportUtil (Maven JXR Parent 2.4-SNAPSHOT API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="JxrReportUtil (Maven JXR Parent 2.4-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/JxrReportUtil.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/maven/plugin/jxr/JxrReport.html" title="class in org.apache.maven.plugin.jxr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugin/jxr/JxrTestReport.html" title="class in org.apache.maven.plugin.jxr"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugin/jxr/JxrReportUtil.html" target="_top">Frames</a></li> +<li><a href="JxrReportUtil.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.maven.plugin.jxr</div> +<h2 title="Class JxrReportUtil" class="title">Class JxrReportUtil</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugin.jxr.JxrReportUtil</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">JxrReportUtil</span> +extends <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Utility class for the jxr report.</div> +<dl><dt><span class="strong">Version:</span></dt> + <dd>$Id: JxrReportUtil.java 1145180 2011-07-11 14:02:55Z bimargulies $</dd> +<dt><span class="strong">Author:</span></dt> + <dd><a href="mailto:vincent.sive...@gmail.com";>Vincent Siveton</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/maven/plugin/jxr/JxrReportUtil.html#JxrReportUtil()">JxrReportUtil</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugin/jxr/JxrReportUtil.html#getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject, java.lang.String, java.lang.String)">getMavenJavadocPluginBasicOption</a></strong>(org.apache.maven.project.MavenProject project, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> optionName, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> defaultValue)</code> +<div class="block">Return the <code>optionName</code> value defined in a project for the "maven-javadoc-plugin" plugin.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugin/jxr/JxrReportUtil.html#getMavenJavadocPlugins(org.apache.maven.project.MavenProject)">getMavenJavadocPlugins</a></strong>(org.apache.maven.project.MavenProject project)</code> +<div class="block">Return the plugin references for the javadoc plugin in a project.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugin/jxr/JxrReportUtil.html#getStructure(org.apache.maven.project.MavenProject, boolean)">getStructure</a></strong>(org.apache.maven.project.MavenProject project, + boolean ignoreMissingSiteUrl)</code> +<div class="block">Generates the site structure using the project hierarchy (project and its modules) or using the + distributionManagement elements from the pom.xml.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugin/jxr/JxrReportUtil.html#isJavadocAggregated(org.apache.maven.project.MavenProject)">isJavadocAggregated</a></strong>(org.apache.maven.project.MavenProject project)</code> +<div class="block">Determine if javadoc is aggregated in this project, paying attention to both + TODO: take cognizance of javadoc versus test-javadoc + the old parameter and the new mojo.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/jav ase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="JxrReportUtil()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>JxrReportUtil</h4> +<pre>public JxrReportUtil()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isJavadocAggregated(org.apache.maven.project.MavenProject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isJavadocAggregated</h4> +<pre>protected static boolean isJavadocAggregated(org.apache.maven.project.MavenProject project) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Determine if javadoc is aggregated in this project, paying attention to both + TODO: take cognizance of javadoc versus test-javadoc + the old parameter and the new mojo.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMavenJavadocPluginBasicOption</h4> +<pre>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getMavenJavadocPluginBasicOption(org.apache.maven.project.MavenProject project, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> optionName, + <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> defaultValue) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Return the <code>optionName</code> value defined in a project for the "maven-javadoc-plugin" plugin.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - not null</dd><dd><code>optionName</code> - the option name wanted</dd><dd><code>defaultValue</code> - a default value</dd> +<dt><span class="strong">Returns:</span></dt><dd>the value for the option name or the default value. Could be null if not found.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if any</dd></dl> +</li> +</ul> +<a name="getMavenJavadocPlugins(org.apache.maven.project.MavenProject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMavenJavadocPlugins</h4> +<pre>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> getMavenJavadocPlugins(org.apache.maven.project.MavenProject project) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Return the plugin references for the javadoc plugin in a project.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - not null</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if any</dd></dl> +</li> +</ul> +<a name="getStructure(org.apache.maven.project.MavenProject, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getStructure</h4> +<pre>protected static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getStructure(org.apache.maven.project.MavenProject project, + boolean ignoreMissingSiteUrl) + throws <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Generates the site structure using the project hierarchy (project and its modules) or using the + distributionManagement elements from the pom.xml.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>project</code> - </dd><dd><code>ignoreMissingSiteUrl</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>the structure relative path</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - if any</dd><dt><span class="strong">See Also:</span></dt><dd><code>org.apache.maven.plugins.site.SiteStageMojo#getStructure( MavenProject project, boolean ignoreMissingSiteUrl )</code></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/JxrReportUtil.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/maven/plugin/jxr/JxrReport.html" title="class in org.apache.maven.plugin.jxr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugin/jxr/JxrTestReport.html" title="class in org.apache.maven.plugin.jxr"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugin/jxr/JxrReportUtil.html" target="_top">Frames</a></li> +<li><a href="JxrReportUtil.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2002–2013 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> </html> \ No newline at end of file
