Skip to content

Commit

Permalink
Update JavaDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@3breadt
3breadt committed Aug 21, 2018
1 parent 64ee7a2 commit 43789cf
Show file tree
Hide file tree
Showing 49 changed files with 1,042 additions and 485 deletions.
6 changes: 3 additions & 3 deletions docs/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:14 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (dd-plist 1.20 API)</title>
<meta name="date" content="2017-07-20">
<title>All Classes (dd-plist 1.21 API)</title>
<meta name="date" content="2018-08-21">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
6 changes: 3 additions & 3 deletions docs/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:14 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>All Classes (dd-plist 1.20 API)</title>
<meta name="date" content="2017-07-20">
<title>All Classes (dd-plist 1.21 API)</title>
<meta name="date" content="2018-08-21">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
130 changes: 112 additions & 18 deletions docs/com/dd/plist/ASCIIPropertyListParser.html
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/com/dd/plist/Base64.B64InputStream.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:13 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Base64.B64InputStream (dd-plist 1.20 API)</title>
<meta name="date" content="2017-07-20">
<title>Base64.B64InputStream (dd-plist 1.21 API)</title>
<meta name="date" content="2018-08-21">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Base64.B64InputStream (dd-plist 1.20 API)";
parent.document.title="Base64.B64InputStream (dd-plist 1.21 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -417,6 +417,6 @@ <h4>read</h4>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All Rights Reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2018. All Rights Reserved.</small></p>
</body>
</html>
10 changes: 5 additions & 5 deletions docs/com/dd/plist/Base64.B64OutputStream.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:13 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Base64.B64OutputStream (dd-plist 1.20 API)</title>
<meta name="date" content="2017-07-20">
<title>Base64.B64OutputStream (dd-plist 1.21 API)</title>
<meta name="date" content="2018-08-21">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Base64.B64OutputStream (dd-plist 1.20 API)";
parent.document.title="Base64.B64OutputStream (dd-plist 1.21 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -516,6 +516,6 @@ <h4>resumeEncoding</h4>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All Rights Reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2018. All Rights Reserved.</small></p>
</body>
</html>
10 changes: 5 additions & 5 deletions docs/com/dd/plist/Base64.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:13 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Base64 (dd-plist 1.20 API)</title>
<meta name="date" content="2017-07-20">
<title>Base64 (dd-plist 1.21 API)</title>
<meta name="date" content="2018-08-21">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Base64 (dd-plist 1.20 API)";
parent.document.title="Base64 (dd-plist 1.21 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -1390,6 +1390,6 @@ <h4>decodeFileToFile</h4>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All Rights Reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2018. All Rights Reserved.</small></p>
</body>
</html>
26 changes: 13 additions & 13 deletions docs/com/dd/plist/BinaryPropertyListParser.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:13 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BinaryPropertyListParser (dd-plist 1.20 API)</title>
<meta name="date" content="2017-07-20">
<title>BinaryPropertyListParser (dd-plist 1.21 API)</title>
<meta name="date" content="2018-08-21">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BinaryPropertyListParser (dd-plist 1.20 API)";
parent.document.title="BinaryPropertyListParser (dd-plist 1.21 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -242,10 +242,10 @@ <h4>parse</h4>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>data</code> - The binary property list's data.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The root object of the property list. This is usually a {@link NSDictionary} but can also be a {@link NSArray}.</dd>
<dd>The root object of the property list. This is usually a <a href="../../../com/dd/plist/NSDictionary.html" title="class in com.dd.plist"><code>NSDictionary</code></a> but can also be a <a href="../../../com/dd/plist/NSArray.html" title="class in com.dd.plist"><code>NSArray</code></a>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/dd/plist/PropertyListFormatException.html" title="class in com.dd.plist">PropertyListFormatException</a></code> - When the property list's format could not be parsed.</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io">UnsupportedEncodingException</a></code> - When a NSString object could not be decoded.</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io">UnsupportedEncodingException</a></code> - If a <a href="../../../com/dd/plist/NSString.html" title="class in com.dd.plist"><code>NSString</code></a> object could not be decoded.</dd>
</dl>
</li>
</ul>
Expand All @@ -258,15 +258,16 @@ <h4>parse</h4>
<pre>public static&nbsp;<a href="../../../com/dd/plist/NSObject.html" title="class in com.dd.plist">NSObject</a>&nbsp;parse(<a href="http://download.oracle.com/javase/6/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a>&nbsp;is)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="../../../com/dd/plist/PropertyListFormatException.html" title="class in com.dd.plist">PropertyListFormatException</a></pre>
<div class="block">Parses a binary property list from an input stream.</div>
<div class="block">Parses a binary property list from an input stream.
This method does not close the specified input stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>is</code> - The input stream that points to the property list's data.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The root object of the property list. This is usually a {@link NSDictionary} but can also be a {@link NSArray}.</dd>
<dd>The root object of the property list. This is usually a <a href="../../../com/dd/plist/NSDictionary.html" title="class in com.dd.plist"><code>NSDictionary</code></a> but can also be a <a href="../../../com/dd/plist/NSArray.html" title="class in com.dd.plist"><code>NSArray</code></a>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/dd/plist/PropertyListFormatException.html" title="class in com.dd.plist">PropertyListFormatException</a></code> - When the property list's format could not be parsed.</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When a NSString object could not be decoded or an InputStream IO error occurs.</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If a <a href="../../../com/dd/plist/NSString.html" title="class in com.dd.plist"><code>NSString</code></a> object could not be decoded or an I/O error occurs on the input stream.</dd>
</dl>
</li>
</ul>
Expand All @@ -284,11 +285,10 @@ <h4>parse</h4>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>f</code> - The binary property list file</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The root object of the property list. This is usually a {@link NSDictionary} but can also be a {@link NSArray}.</dd>
<dd>The root object of the property list. This is usually a <a href="../../../com/dd/plist/NSDictionary.html" title="class in com.dd.plist"><code>NSDictionary</code></a> but can also be a <a href="../../../com/dd/plist/NSArray.html" title="class in com.dd.plist"><code>NSArray</code></a>.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../com/dd/plist/PropertyListFormatException.html" title="class in com.dd.plist">PropertyListFormatException</a></code> - When the property list's format could not be parsed.</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/UnsupportedEncodingException.html?is-external=true" title="class or interface in java.io">UnsupportedEncodingException</a></code> - When a NSString object could not be decoded or a file IO error occurs.</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If a <a href="../../../com/dd/plist/NSString.html" title="class in com.dd.plist"><code>NSString</code></a> object could not be decoded or an I/O error occurs on the input stream.</dd>
</dl>
</li>
</ul>
Expand Down Expand Up @@ -488,6 +488,6 @@ <h4>copyOfRange</h4>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All Rights Reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2018. All Rights Reserved.</small></p>
</body>
</html>
19 changes: 10 additions & 9 deletions docs/com/dd/plist/BinaryPropertyListWriter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:13 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BinaryPropertyListWriter (dd-plist 1.20 API)</title>
<meta name="date" content="2017-07-20">
<title>BinaryPropertyListWriter (dd-plist 1.21 API)</title>
<meta name="date" content="2018-08-21">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BinaryPropertyListWriter (dd-plist 1.20 API)";
parent.document.title="BinaryPropertyListWriter (dd-plist 1.21 API)";
}
}
catch(err) {
Expand Down Expand Up @@ -195,7 +195,7 @@ <h4>write</h4>
<dd><code>file</code> - the file to write to</dd>
<dd><code>root</code> - the source of the data to write to the file</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When an IO error occurs while writing to the file or the object structure contains
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while writing to the file or the object structure contains
data that cannot be saved.</dd>
</dl>
</li>
Expand All @@ -209,13 +209,14 @@ <h4>write</h4>
<pre>public static&nbsp;void&nbsp;write(<a href="http://download.oracle.com/javase/6/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a>&nbsp;out,
<a href="../../../com/dd/plist/NSObject.html" title="class in com.dd.plist">NSObject</a>&nbsp;root)
throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
<div class="block">Writes a binary plist serialization of the given object as the root.</div>
<div class="block">Writes a binary plist serialization of the given object as the root.
This method does not close the output stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>out</code> - the stream to write to</dd>
<dd><code>root</code> - the source of the data to write to the stream</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When an IO error occurs while writing to the stream or the object structure contains
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while writing to the stream or the object structure contains
data that cannot be saved.</dd>
</dl>
</li>
Expand All @@ -236,7 +237,7 @@ <h4>writeToArray</h4>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The byte array containing the serialized property list</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - When an IO error occurs while writing to the stream or the object structure contains
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs while writing to the stream or the object structure contains
data that cannot be saved.</dd>
</dl>
</li>
Expand Down Expand Up @@ -309,6 +310,6 @@ <h4>writeToArray</h4>
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017. All Rights Reserved.</small></p>
<p class="legalCopy"><small>Copyright &#169; 2018. All Rights Reserved.</small></p>
</body>
</html>
Loading

0 comments on commit 43789cf

Please sign in to comment.