Added: websites/production/maven/content/jxr-archives/jxr-LATEST/apidocs/org/apache/maven/jxr/DirectoryIndexer.html ============================================================================== --- websites/production/maven/content/jxr-archives/jxr-LATEST/apidocs/org/apache/maven/jxr/DirectoryIndexer.html (added) +++ websites/production/maven/content/jxr-archives/jxr-LATEST/apidocs/org/apache/maven/jxr/DirectoryIndexer.html Mon Dec 9 00:21:44 2013 @@ -0,0 +1,468 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="de"> +<head> +<!-- Generated by javadoc (version 1.7.0_45) on Mon Dec 09 00:57:39 CET 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>DirectoryIndexer (Maven JXR Parent 2.4-SNAPSHOT API)</title> +<meta name="date" content="2013-12-09"> +<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="DirectoryIndexer (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/DirectoryIndexer.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>Prev Class</li> +<li><a href="../../../../org/apache/maven/jxr/JavaCodeTransform.html" title="class in org.apache.maven.jxr"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/maven/jxr/DirectoryIndexer.html" target="_top">Frames</a></li> +<li><a href="DirectoryIndexer.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.jxr</div> +<h2 title="Class DirectoryIndexer" class="title">Class DirectoryIndexer</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.jxr.DirectoryIndexer</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">DirectoryIndexer</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">This class creates the navigational pages for jxr's cross-referenced source + files. The navigation is inspired by javadoc, so it should have a familiar feel. + + Creates the following files: + <ul> + <li><code>index.html</code> main index containing the frameset</li> + <li><code>overview-frame.html</code> list of the project's packages (top left)</li> + <li><code>allclasses-frame.html</code> list of all classes in the project (bottom left)</li> + <li><code>overview-summary.html</code> top-level listing of the project's packages (main frame)</li> + + <li> + Package specific: + <ul> + <li><code>package-summary.html</code> listing of all classes in this package (main frame)</li> + <li><code>package-frame.html</code> listing of all classes in this package (bottom left)</li> + </ul> + </li> + </ul></div> +<dl><dt><span class="strong">Version:</span></dt> + <dd>$Id: DirectoryIndexer.java 1160901 2011-08-23 22:09:33Z bimargulies $</dd> +<dt><span class="strong">Author:</span></dt> + <dd><a href="mailto:belling...@gmail.com";>Fabrice Bellingard </a>, <a href="mailto:br...@brainslug.org";>Brian Leonard</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/jxr/DirectoryIndexer.html#DirectoryIndexer(org.apache.maven.jxr.pacman.PackageManager, java.lang.String)">DirectoryIndexer</a></strong>(<a href="../../../../org/apache/maven/jxr/pacman/PackageManager.html" title="class in org.apache.maven.jxr.pacman">PackageManager</a> packageManager, + <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> root)</code> +<div class="block">Constructor for the DirectoryIndexer object</div> +</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><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/jxr/DirectoryIndexer.html#getBottom()">getBottom</a></strong>()</code> +<div class="block">see setBottom(String)</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/jxr/DirectoryIndexer.html#getDocTitle()">getDocTitle</a></strong>()</code> +<div class="block">see setDocTitle(String)</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/jxr/DirectoryIndexer.html#getOutputEncoding()">getOutputEncoding</a></strong>()</code> +<div class="block">see setOutputEncoding(String)</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/jxr/DirectoryIndexer.html#getTemplateDir()">getTemplateDir</a></strong>()</code> +<div class="block">see setTemplateDir(String)</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/jxr/DirectoryIndexer.html#getWindowTitle()">getWindowTitle</a></strong>()</code> +<div class="block">see setWindowTitle(String)</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/DirectoryIndexer.html#process(org.apache.maven.jxr.log.Log)">process</a></strong>(<a href="../../../../org/apache/maven/jxr/log/Log.html" title="interface in org.apache.maven.jxr.log">Log</a> log)</code> +<div class="block">Does the actual indexing.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/DirectoryIndexer.html#setBottom(java.lang.String)">setBottom</a></strong>(<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> bottom)</code> +<div class="block">Bottom is a footer for the navigation pages, usually a copyright + see the javadoc documentation for the property of the same name</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/DirectoryIndexer.html#setDocTitle(java.lang.String)">setDocTitle</a></strong>(<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> docTitle)</code> +<div class="block">DocTitle is used as a page heading for the summary files + see the javadoc documentation for the property of the same name</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/DirectoryIndexer.html#setOutputEncoding(java.lang.String)">setOutputEncoding</a></strong>(<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> outputEncoding)</code> +<div class="block">OutputEncoding is the encoding of output files.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/DirectoryIndexer.html#setTemplateDir(java.lang.String)">setTemplateDir</a></strong>(<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> templateDir)</code> +<div class="block">TemplateDir is the location of the jelly template files used + to generate the navigation pages.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/DirectoryIndexer.html#setWindowTitle(java.lang.String)">setWindowTitle</a></strong>(<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> windowTitle)</code> +<div class="block">WindowTitle is used in the output's <title> tags + see the javadoc documentation for the property of the same name</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="DirectoryIndexer(org.apache.maven.jxr.pacman.PackageManager, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DirectoryIndexer</h4> +<pre>public DirectoryIndexer(<a href="../../../../org/apache/maven/jxr/pacman/PackageManager.html" title="class in org.apache.maven.jxr.pacman">PackageManager</a> packageManager, + <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> root)</pre> +<div class="block">Constructor for the DirectoryIndexer object</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>packageManager</code> - PackageManager for this project</dd><dd><code>root</code> - Path of the root output directory</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setOutputEncoding(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOutputEncoding</h4> +<pre>public void setOutputEncoding(<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> outputEncoding)</pre> +<div class="block">OutputEncoding is the encoding of output files.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>outputEncoding</code> - output Encoding</dd></dl> +</li> +</ul> +<a name="getOutputEncoding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutputEncoding</h4> +<pre>public <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> getOutputEncoding()</pre> +<div class="block">see setOutputEncoding(String)</div> +</li> +</ul> +<a name="setTemplateDir(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTemplateDir</h4> +<pre>public void setTemplateDir(<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> templateDir)</pre> +<div class="block">TemplateDir is the location of the jelly template files used + to generate the navigation pages.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>templateDir</code> - location of the template directory</dd></dl> +</li> +</ul> +<a name="getTemplateDir()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTemplateDir</h4> +<pre>public <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> getTemplateDir()</pre> +<div class="block">see setTemplateDir(String)</div> +</li> +</ul> +<a name="setWindowTitle(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWindowTitle</h4> +<pre>public void setWindowTitle(<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> windowTitle)</pre> +<div class="block">WindowTitle is used in the output's <title> tags + see the javadoc documentation for the property of the same name</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>windowTitle</code> - the <title> attribute</dd></dl> +</li> +</ul> +<a name="getWindowTitle()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWindowTitle</h4> +<pre>public <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> getWindowTitle()</pre> +<div class="block">see setWindowTitle(String)</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/maven/jxr/DirectoryIndexer.html#setWindowTitle(java.lang.String)"><code>setWindowTitle</code></a></dd></dl> +</li> +</ul> +<a name="setDocTitle(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDocTitle</h4> +<pre>public void setDocTitle(<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> docTitle)</pre> +<div class="block">DocTitle is used as a page heading for the summary files + see the javadoc documentation for the property of the same name</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>docTitle</code> - major page heading</dd></dl> +</li> +</ul> +<a name="getDocTitle()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDocTitle</h4> +<pre>public <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> getDocTitle()</pre> +<div class="block">see setDocTitle(String)</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/maven/jxr/DirectoryIndexer.html#setDocTitle(java.lang.String)"><code>setDocTitle</code></a></dd></dl> +</li> +</ul> +<a name="setBottom(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBottom</h4> +<pre>public void setBottom(<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> bottom)</pre> +<div class="block">Bottom is a footer for the navigation pages, usually a copyright + see the javadoc documentation for the property of the same name</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bottom</code> - page footer</dd></dl> +</li> +</ul> +<a name="getBottom()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBottom</h4> +<pre>public <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> getBottom()</pre> +<div class="block">see setBottom(String)</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/maven/jxr/DirectoryIndexer.html#setBottom(java.lang.String)"><code>setBottom</code></a></dd></dl> +</li> +</ul> +<a name="process(org.apache.maven.jxr.log.Log)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>process</h4> +<pre>public void process(<a href="../../../../org/apache/maven/jxr/log/Log.html" title="interface in org.apache.maven.jxr.log">Log</a> log) + throws <a href="../../../../org/apache/maven/jxr/JxrException.html" title="class in org.apache.maven.jxr">JxrException</a></pre> +<div class="block">Does the actual indexing.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/maven/jxr/JxrException.html" title="class in org.apache.maven.jxr">JxrException</a></code> - If something went wrong</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/DirectoryIndexer.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>Prev Class</li> +<li><a href="../../../../org/apache/maven/jxr/JavaCodeTransform.html" title="class in org.apache.maven.jxr"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/maven/jxr/DirectoryIndexer.html" target="_top">Frames</a></li> +<li><a href="DirectoryIndexer.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
Added: websites/production/maven/content/jxr-archives/jxr-LATEST/apidocs/org/apache/maven/jxr/JXR.html ============================================================================== --- websites/production/maven/content/jxr-archives/jxr-LATEST/apidocs/org/apache/maven/jxr/JXR.html (added) +++ websites/production/maven/content/jxr-archives/jxr-LATEST/apidocs/org/apache/maven/jxr/JXR.html Mon Dec 9 00:21:44 2013 @@ -0,0 +1,492 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="de"> +<head> +<!-- Generated by javadoc (version 1.7.0_45) on Mon Dec 09 00:57:40 CET 2013 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>JXR (Maven JXR Parent 2.4-SNAPSHOT API)</title> +<meta name="date" content="2013-12-09"> +<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="JXR (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/JXR.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/jxr/JavaCodeTransform.html" title="class in org.apache.maven.jxr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/maven/jxr/JxrException.html" title="class in org.apache.maven.jxr"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/maven/jxr/JXR.html" target="_top">Frames</a></li> +<li><a href="JXR.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.jxr</div> +<h2 title="Class JXR" class="title">Class JXR</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.jxr.JXR</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">JXR</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">Main entry point into Maven used to kick off the XReference code building.</div> +<dl><dt><span class="strong">Version:</span></dt> + <dd>$Id: JXR.java 1544863 2013-11-23 18:54:06Z michaelo $</dd> +<dt><span class="strong">Author:</span></dt> + <dd><a href="mailto:bur...@apache.org";>Kevin A. Burton</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/jxr/JXR.html#JXR()">JXR</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><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/jxr/JXR.html#getDest()">getDest</a></strong>()</code> +<div class="block">Get the path to the destination files.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#isHtmlFile(java.lang.String)">isHtmlFile</a></strong>(<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> filename)</code> +<div class="block">Check to see if the file is an HTML file.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#isJavaFile(java.lang.String)">isJavaFile</a></strong>(<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> filename)</code> +<div class="block">Check to see if the file is a Java source file.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#processPath(org.apache.maven.jxr.pacman.PackageManager, java.lang.String, java.lang.String)">processPath</a></strong>(<a href="../../../../org/apache/maven/jxr/pacman/PackageManager.html" title="class in org.apache.maven.jxr.pacman">PackageManager</a> packageManager, + <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> source, + <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> bottom)</code> +<div class="block">Now that we have instantiated everything.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#setDest(java.lang.String)">setDest</a></strong>(<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> dest)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#setExcludes(java.lang.String[])">setExcludes</a></strong>(<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>[] excludes)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#setIncludes(java.lang.String[])">setIncludes</a></strong>(<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>[] includes)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#setInputEncoding(java.lang.String)">setInputEncoding</a></strong>(<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> inputEncoding)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#setJavadocLinkDir(java.lang.String)">setJavadocLinkDir</a></strong>(<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> javadocLinkDir)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#setLocale(java.util.Locale)">setLocale</a></strong>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#setLog(org.apache.maven.jxr.log.Log)">setLog</a></strong>(<a href="../../../../org/apache/maven/jxr/log/Log.html" title="interface in org.apache.maven.jxr.log">Log</a> log)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#setOutputEncoding(java.lang.String)">setOutputEncoding</a></strong>(<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> outputEncoding)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#setRevision(java.lang.String)">setRevision</a></strong>(<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> revision)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#setTransformer(org.apache.maven.jxr.JavaCodeTransform)">setTransformer</a></strong>(<a href="../../../../org/apache/maven/jxr/JavaCodeTransform.html" title="class in org.apache.maven.jxr">JavaCodeTransform</a> transformer)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/maven/jxr/JXR.html#xref(java.util.List, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">xref</a></strong>(<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> sourceDirs, + <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> templateDir, + <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> windowTitle, + <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> docTitle, + <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> bottom)</code> </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="JXR()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>JXR</h4> +<pre>public JXR()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="processPath(org.apache.maven.jxr.pacman.PackageManager, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>processPath</h4> +<pre>public void processPath(<a href="../../../../org/apache/maven/jxr/pacman/PackageManager.html" title="class in org.apache.maven.jxr.pacman">PackageManager</a> packageManager, + <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> source, + <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> bottom) + 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">Now that we have instantiated everything. Process this JXR task.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>packageManager</code> - </dd><dd><code>source</code> - </dd><dd><code>bottom</code> - </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="isJavaFile(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isJavaFile</h4> +<pre>public static boolean isJavaFile(<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> filename)</pre> +<div class="block">Check to see if the file is a Java source file.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - The name of the file to check</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>true</true> if the file is a Java file</dd></dl> +</li> +</ul> +<a name="isHtmlFile(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isHtmlFile</h4> +<pre>public static boolean isHtmlFile(<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> filename)</pre> +<div class="block">Check to see if the file is an HTML file.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filename</code> - The name of the file to check</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>true</true> if the file is an HTML file</dd></dl> +</li> +</ul> +<a name="getDest()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDest</h4> +<pre>public <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> getDest()</pre> +<div class="block">Get the path to the destination files.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The path to the destination files</dd></dl> +</li> +</ul> +<a name="setDest(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDest</h4> +<pre>public void setDest(<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> dest)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dest</code> - </dd></dl> +</li> +</ul> +<a name="setLocale(java.util.Locale)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLocale</h4> +<pre>public void setLocale(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/util/Locale.html?is-external=true"; title="class or interface in java.util">Locale</a> locale)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - </dd></dl> +</li> +</ul> +<a name="setInputEncoding(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInputEncoding</h4> +<pre>public void setInputEncoding(<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> inputEncoding)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>inputEncoding</code> - </dd></dl> +</li> +</ul> +<a name="setOutputEncoding(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOutputEncoding</h4> +<pre>public void setOutputEncoding(<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> outputEncoding)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>outputEncoding</code> - </dd></dl> +</li> +</ul> +<a name="setJavadocLinkDir(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setJavadocLinkDir</h4> +<pre>public void setJavadocLinkDir(<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> javadocLinkDir)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>javadocLinkDir</code> - </dd></dl> +</li> +</ul> +<a name="setTransformer(org.apache.maven.jxr.JavaCodeTransform)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransformer</h4> +<pre>public void setTransformer(<a href="../../../../org/apache/maven/jxr/JavaCodeTransform.html" title="class in org.apache.maven.jxr">JavaCodeTransform</a> transformer)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>transformer</code> - </dd></dl> +</li> +</ul> +<a name="setRevision(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRevision</h4> +<pre>public void setRevision(<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> revision)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>revision</code> - </dd></dl> +</li> +</ul> +<a name="setLog(org.apache.maven.jxr.log.Log)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLog</h4> +<pre>public void setLog(<a href="../../../../org/apache/maven/jxr/log/Log.html" title="interface in org.apache.maven.jxr.log">Log</a> log)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>log</code> - </dd></dl> +</li> +</ul> +<a name="xref(java.util.List, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>xref</h4> +<pre>public void xref(<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> sourceDirs, + <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> templateDir, + <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> windowTitle, + <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> docTitle, + <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> bottom) + 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>, + <a href="../../../../org/apache/maven/jxr/JxrException.html" title="class in org.apache.maven.jxr">JxrException</a></pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sourceDirs</code> - </dd><dd><code>templateDir</code> - </dd><dd><code>windowTitle</code> - </dd><dd><code>docTitle</code> - </dd><dd><code>bottom</code> - </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> +<dd><code><a href="../../../../org/apache/maven/jxr/JxrException.html" title="class in org.apache.maven.jxr">JxrException</a></code></dd></dl> +</li> +</ul> +<a name="setExcludes(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExcludes</h4> +<pre>public void setExcludes(<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>[] excludes)</pre> +</li> +</ul> +<a name="setIncludes(java.lang.String[])"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setIncludes</h4> +<pre>public void setIncludes(<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>[] includes)</pre> +</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/JXR.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/jxr/JavaCodeTransform.html" title="class in org.apache.maven.jxr"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/maven/jxr/JxrException.html" title="class in org.apache.maven.jxr"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/maven/jxr/JXR.html" target="_top">Frames</a></li> +<li><a href="JXR.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
