Skip to content

Commit

Permalink
Add Javadoc to website (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
rvesse committed Jan 19, 2016
1 parent 93ee883 commit 69aea39
Show file tree
Hide file tree
Showing 1,604 changed files with 335,318 additions and 0 deletions.
6 changes: 6 additions & 0 deletions javadoc/2.1.0/airline-help-bash/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Manifest-Version: 1.0
Built-By: rvesse
Build-Jdk: 1.7.0_45
Created-By: Apache Maven 3.3.3
Archiver-Version: Plexus Archiver

21 changes: 21 additions & 0 deletions javadoc/2.1.0/airline-help-bash/allclasses-frame.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Thu Nov 26 10:46:53 GMT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>All Classes (Airline - Help - Bash 2.1.0 API)</title>
<meta name="date" content="2015-11-26">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>
<h1 class="bar">All Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="com/github/rvesse/airline/annotations/help/BashCompletion.html" title="annotation in com.github.rvesse.airline.annotations.help" target="classFrame">BashCompletion</a></li>
<li><a href="com/github/rvesse/airline/help/cli/bash/BashCompletionGenerator.html" title="class in com.github.rvesse.airline.help.cli.bash" target="classFrame">BashCompletionGenerator</a></li>
<li><a href="com/github/rvesse/airline/help/cli/bash/CompletionBehaviour.html" title="enum in com.github.rvesse.airline.help.cli.bash" target="classFrame">CompletionBehaviour</a></li>
</ul>
</div>
</body>
</html>
21 changes: 21 additions & 0 deletions javadoc/2.1.0/airline-help-bash/allclasses-noframe.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Thu Nov 26 10:46:53 GMT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>All Classes (Airline - Help - Bash 2.1.0 API)</title>
<meta name="date" content="2015-11-26">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
</head>
<body>
<h1 class="bar">All Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="com/github/rvesse/airline/annotations/help/BashCompletion.html" title="annotation in com.github.rvesse.airline.annotations.help">BashCompletion</a></li>
<li><a href="com/github/rvesse/airline/help/cli/bash/BashCompletionGenerator.html" title="class in com.github.rvesse.airline.help.cli.bash">BashCompletionGenerator</a></li>
<li><a href="com/github/rvesse/airline/help/cli/bash/CompletionBehaviour.html" title="enum in com.github.rvesse.airline.help.cli.bash">CompletionBehaviour</a></li>
</ul>
</div>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,242 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Thu Nov 26 10:46:53 GMT 2015 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>BashCompletion (Airline - Help - Bash 2.1.0 API)</title>
<meta name="date" content="2015-11-26">
<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="BashCompletion (Airline - Help - Bash 2.1.0 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/BashCompletion.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>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/github/rvesse/airline/annotations/help/BashCompletion.html" target="_top">Frames</a></li>
<li><a href="BashCompletion.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:&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#annotation_type_element_detail">Element</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">com.github.rvesse.airline.annotations.help</div>
<h2 title="Annotation Type BashCompletion" class="title">Annotation Type BashCompletion</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>)
public @interface <span class="strong">BashCompletion</span></pre>
<div class="block">Annotates a field with Bash completion information</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation_type_optional_element_summary">
<!-- -->
</a>
<h3>Optional Element Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Optional Element and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../com/github/rvesse/airline/help/cli/bash/CompletionBehaviour.html" title="enum in com.github.rvesse.airline.help.cli.bash">CompletionBehaviour</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../com/github/rvesse/airline/annotations/help/BashCompletion.html#behaviour()">behaviour</a></strong></code>
<div class="block">Sets the desired completion behaviour</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="../../../../../../com/github/rvesse/airline/annotations/help/BashCompletion.html#command()">command</a></strong></code>
<div class="block">Provides a command used to generate the completion words for this option</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="annotation_type_element_detail">
<!-- -->
</a>
<h3>Element Detail</h3>
<a name="behaviour()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>behaviour</h4>
<pre>public abstract&nbsp;<a href="../../../../../../com/github/rvesse/airline/help/cli/bash/CompletionBehaviour.html" title="enum in com.github.rvesse.airline.help.cli.bash">CompletionBehaviour</a>&nbsp;behaviour</pre>
<div class="block">Sets the desired completion behaviour
<p>
This is used by usage generators that are capable of generating
completion scripts. It indicates any additional completion behaviour that
should apply in addition to <a href="../../../../../../com/github/rvesse/airline/annotations/help/BashCompletion.html#command()"><code>command()</code></a> or other behaviours
obtained from the option/argument meta-data.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Completion Behaviours</dd></dl>
<dl>
<dt>Default:</dt>
<dd>com.github.rvesse.airline.help.cli.bash.CompletionBehaviour.NONE</dd>
</dl>
</li>
</ul>
<a name="command()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>command</h4>
<pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;command</pre>
<div class="block">Provides a command used to generate the completion words for this option
<p>
This is used by usage generators that are capable of generating
completion scripts.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Completion command</dd></dl>
<dl>
<dt>Default:</dt>
<dd>""</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/BashCompletion.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>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?com/github/rvesse/airline/annotations/help/BashCompletion.html" target="_top">Frames</a></li>
<li><a href="BashCompletion.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:&nbsp;</li>
<li>Required&nbsp;|&nbsp;</li>
<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#annotation_type_element_detail">Element</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2012&#x2013;2015. All rights reserved.</small></p>
</body>
</html>
Loading

0 comments on commit 69aea39

Please sign in to comment.