Skip to content

Commit

Permalink
Update JavaDoc for 2.2.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinstadler committed May 27, 2019
1 parent 0ed2544 commit bd55c04
Show file tree
Hide file tree
Showing 13 changed files with 515 additions and 6 deletions.
1 change: 1 addition & 0 deletions docs/allclasses-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="processing/sound/Amplitude.html" title="class in processing.sound" target="classFrame">Amplitude</a></li>
<li><a href="processing/sound/AndroidPermissionException.html" title="class in processing.sound" target="classFrame">AndroidPermissionException</a></li>
<li><a href="processing/sound/AudioDevice.html" title="class in processing.sound" target="classFrame">AudioDevice</a></li>
<li><a href="processing/sound/AudioIn.html" title="class in processing.sound" target="classFrame">AudioIn</a></li>
<li><a href="processing/sound/AudioSample.html" title="class in processing.sound" target="classFrame">AudioSample</a></li>
Expand Down
1 change: 1 addition & 0 deletions docs/allclasses-noframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ <h1 class="bar">All&nbsp;Classes</h1>
<div class="indexContainer">
<ul>
<li><a href="processing/sound/Amplitude.html" title="class in processing.sound">Amplitude</a></li>
<li><a href="processing/sound/AndroidPermissionException.html" title="class in processing.sound">AndroidPermissionException</a></li>
<li><a href="processing/sound/AudioDevice.html" title="class in processing.sound">AudioDevice</a></li>
<li><a href="processing/sound/AudioIn.html" title="class in processing.sound">AudioIn</a></li>
<li><a href="processing/sound/AudioSample.html" title="class in processing.sound">AudioSample</a></li>
Expand Down
7 changes: 7 additions & 0 deletions docs/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,13 @@ <h2 class="title">A</h2>
<dd>
<div class="block">Gets the content of the current audiobuffer from the input source.</div>
</dd>
<dt><a href="processing/sound/AndroidPermissionException.html" title="class in processing.sound"><span class="typeNameLink">AndroidPermissionException</span></a> - Exception in <a href="processing/sound/package-summary.html">processing.sound</a></dt>
<dd>
<div class="block">AndroidPermissionException is thrown when trying to create an AudioIn on
Android when you have not granted the required RECORD_AUDIO permission.</div>
</dd>
<dt><span class="memberNameLink"><a href="processing/sound/AndroidPermissionException.html#AndroidPermissionException-java.lang.String-">AndroidPermissionException(String)</a></span> - Constructor for exception processing.sound.<a href="processing/sound/AndroidPermissionException.html" title="class in processing.sound">AndroidPermissionException</a></dt>
<dd>&nbsp;</dd>
<dt><a href="processing/sound/AudioDevice.html" title="class in processing.sound"><span class="typeNameLink">AudioDevice</span></a> - Class in <a href="processing/sound/package-summary.html">processing.sound</a></dt>
<dd>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/member-search-index.js

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions docs/overview-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,19 @@ <h2 title="Class Hierarchy">Class Hierarchy</h2>
</li>
</ul>
</li>
<li class="circle">java.lang.Throwable (implements java.io.Serializable)
<ul>
<li class="circle">java.lang.Exception
<ul>
<li class="circle">java.lang.RuntimeException
<ul>
<li class="circle">processing.sound.<a href="processing/sound/AndroidPermissionException.html" title="class in processing.sound"><span class="typeNameLink">AndroidPermissionException</span></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="circle">processing.sound.<a href="processing/sound/Waveform.html" title="class in processing.sound"><span class="typeNameLink">Waveform</span></a></li>
</ul>
</li>
Expand Down
4 changes: 2 additions & 2 deletions docs/processing/sound/Amplitude.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../processing/sound/AudioDevice.html" title="class in processing.sound"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../../processing/sound/AndroidPermissionException.html" title="class in processing.sound"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?processing/sound/Amplitude.html" target="_top">Frames</a></li>
Expand Down Expand Up @@ -286,7 +286,7 @@ <h4>input</h4>
<div class="subNav">
<ul class="navList">
<li>Prev&nbsp;Class</li>
<li><a href="../../processing/sound/AudioDevice.html" title="class in processing.sound"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
<li><a href="../../processing/sound/AndroidPermissionException.html" title="class in processing.sound"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?processing/sound/Amplitude.html" target="_top">Frames</a></li>
Expand Down
291 changes: 291 additions & 0 deletions docs/processing/sound/AndroidPermissionException.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,291 @@
<!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 -->
<title>AndroidPermissionException (Javadocs: Processing Sound)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../script.js"></script>
<script type="text/javascript" src="../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../jquery/jquery-1.10.2.js"></script>
<script type="text/javascript" src="../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AndroidPermissionException (Javadocs: Processing Sound)";
}
}
catch(err) {
}
//-->
var pathtoroot = "../../";loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../processing/sound/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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="../../processing/sound/Amplitude.html" title="class in processing.sound"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../processing/sound/AudioDevice.html" title="class in processing.sound"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?processing/sound/AndroidPermissionException.html" target="_top">Frames</a></li>
<li><a href="AndroidPermissionException.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><span>SEARCH:&nbsp;</span>
<input type="text" id="search" value=" " disabled="disabled">
<input type="reset" id="reset" value=" " disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="../../processing/sound/package-summary.html">processing.sound</a></div>
<h2 title="Class AndroidPermissionException" class="title">Class AndroidPermissionException</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.lang.Throwable</li>
<li>
<ul class="inheritance">
<li>java.lang.Exception</li>
<li>
<ul class="inheritance">
<li>java.lang.RuntimeException</li>
<li>
<ul class="inheritance">
<li>processing.sound.AndroidPermissionException</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">AndroidPermissionException</span>
extends java.lang.RuntimeException</pre>
<div class="block">AndroidPermissionException is thrown when trying to create an AudioIn on
Android when you have not granted the required RECORD_AUDIO permission.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../serialized-form.html#processing.sound.AndroidPermissionException">Serialized Form</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="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="../../processing/sound/AndroidPermissionException.html#AndroidPermissionException-java.lang.String-">AndroidPermissionException</a></span>&#8203;(java.lang.String&nbsp;message)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Throwable</h3>
<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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="AndroidPermissionException-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AndroidPermissionException</h4>
<pre>public&nbsp;AndroidPermissionException&#8203;(java.lang.String&nbsp;message)</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../processing/sound/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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="../../processing/sound/Amplitude.html" title="class in processing.sound"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../processing/sound/AudioDevice.html" title="class in processing.sound"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?processing/sound/AndroidPermissionException.html" target="_top">Frames</a></li>
<li><a href="AndroidPermissionException.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.java.lang.Throwable">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Processing Sound</small></p>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/processing/sound/AudioDevice.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../processing/sound/Amplitude.html" title="class in processing.sound"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../processing/sound/AndroidPermissionException.html" title="class in processing.sound"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../processing/sound/AudioIn.html" title="class in processing.sound"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
Expand Down Expand Up @@ -227,7 +227,7 @@ <h4>AudioDevice</h4>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../processing/sound/Amplitude.html" title="class in processing.sound"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../processing/sound/AndroidPermissionException.html" title="class in processing.sound"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../processing/sound/AudioIn.html" title="class in processing.sound"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
Expand Down
4 changes: 4 additions & 0 deletions docs/processing/sound/package-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ <h2 title="Classes">Classes</h2>
<li><a href="Waveform.html" title="class in processing.sound" target="classFrame">Waveform</a></li>
<li><a href="WhiteNoise.html" title="class in processing.sound" target="classFrame">WhiteNoise</a></li>
</ul>
<h2 title="Exceptions">Exceptions</h2>
<ul title="Exceptions">
<li><a href="AndroidPermissionException.html" title="class in processing.sound" target="classFrame">AndroidPermissionException</a></li>
</ul>
</div>
</body>
</html>
Loading

0 comments on commit bd55c04

Please sign in to comment.