Skip to content

Commit 43789cf

Browse files
3breadt3breadt
committed
Update JavaDoc
1 parent 64ee7a2 commit 43789cf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1042
-485
lines changed

‎docs/allclasses-frame.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:14 CEST 2017 -->
5+
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>All Classes (dd-plist 1.20 API)</title>
8-
<meta name="date" content="2017-07-20">
7+
<title>All Classes (dd-plist 1.21 API)</title>
8+
<meta name="date" content="2018-08-21">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<script type="text/javascript" src="script.js"></script>
1111
</head>

‎docs/allclasses-noframe.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:14 CEST 2017 -->
5+
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>All Classes (dd-plist 1.20 API)</title>
8-
<meta name="date" content="2017-07-20">
7+
<title>All Classes (dd-plist 1.21 API)</title>
8+
<meta name="date" content="2018-08-21">
99
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
1010
<script type="text/javascript" src="script.js"></script>
1111
</head>

‎docs/com/dd/plist/ASCIIPropertyListParser.html

+112-18
Large diffs are not rendered by default.

‎docs/com/dd/plist/Base64.B64InputStream.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:13 CEST 2017 -->
5+
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>Base64.B64InputStream (dd-plist 1.20 API)</title>
8-
<meta name="date" content="2017-07-20">
7+
<title>Base64.B64InputStream (dd-plist 1.21 API)</title>
8+
<meta name="date" content="2018-08-21">
99
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
1010
<script type="text/javascript" src="../../../script.js"></script>
1111
</head>
1212
<body>
1313
<script type="text/javascript"><!--
1414
try {
1515
if (location.href.indexOf('is-external=true') == -1) {
16-
parent.document.title="Base64.B64InputStream (dd-plist 1.20 API)";
16+
parent.document.title="Base64.B64InputStream (dd-plist 1.21 API)";
1717
}
1818
}
1919
catch(err) {
@@ -417,6 +417,6 @@ <h4>read</h4>
417417
<!-- -->
418418
</a></div>
419419
<!-- ======== END OF BOTTOM NAVBAR ======= -->
420-
<p class="legalCopy"><small>Copyright &#169; 2017. All Rights Reserved.</small></p>
420+
<p class="legalCopy"><small>Copyright &#169; 2018. All Rights Reserved.</small></p>
421421
</body>
422422
</html>

‎docs/com/dd/plist/Base64.B64OutputStream.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:13 CEST 2017 -->
5+
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>Base64.B64OutputStream (dd-plist 1.20 API)</title>
8-
<meta name="date" content="2017-07-20">
7+
<title>Base64.B64OutputStream (dd-plist 1.21 API)</title>
8+
<meta name="date" content="2018-08-21">
99
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
1010
<script type="text/javascript" src="../../../script.js"></script>
1111
</head>
1212
<body>
1313
<script type="text/javascript"><!--
1414
try {
1515
if (location.href.indexOf('is-external=true') == -1) {
16-
parent.document.title="Base64.B64OutputStream (dd-plist 1.20 API)";
16+
parent.document.title="Base64.B64OutputStream (dd-plist 1.21 API)";
1717
}
1818
}
1919
catch(err) {
@@ -516,6 +516,6 @@ <h4>resumeEncoding</h4>
516516
<!-- -->
517517
</a></div>
518518
<!-- ======== END OF BOTTOM NAVBAR ======= -->
519-
<p class="legalCopy"><small>Copyright &#169; 2017. All Rights Reserved.</small></p>
519+
<p class="legalCopy"><small>Copyright &#169; 2018. All Rights Reserved.</small></p>
520520
</body>
521521
</html>

‎docs/com/dd/plist/Base64.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:13 CEST 2017 -->
5+
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>Base64 (dd-plist 1.20 API)</title>
8-
<meta name="date" content="2017-07-20">
7+
<title>Base64 (dd-plist 1.21 API)</title>
8+
<meta name="date" content="2018-08-21">
99
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
1010
<script type="text/javascript" src="../../../script.js"></script>
1111
</head>
1212
<body>
1313
<script type="text/javascript"><!--
1414
try {
1515
if (location.href.indexOf('is-external=true') == -1) {
16-
parent.document.title="Base64 (dd-plist 1.20 API)";
16+
parent.document.title="Base64 (dd-plist 1.21 API)";
1717
}
1818
}
1919
catch(err) {
@@ -1390,6 +1390,6 @@ <h4>decodeFileToFile</h4>
13901390
<!-- -->
13911391
</a></div>
13921392
<!-- ======== END OF BOTTOM NAVBAR ======= -->
1393-
<p class="legalCopy"><small>Copyright &#169; 2017. All Rights Reserved.</small></p>
1393+
<p class="legalCopy"><small>Copyright &#169; 2018. All Rights Reserved.</small></p>
13941394
</body>
13951395
</html>

‎docs/com/dd/plist/BinaryPropertyListParser.html

+13-13
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:13 CEST 2017 -->
5+
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>BinaryPropertyListParser (dd-plist 1.20 API)</title>
8-
<meta name="date" content="2017-07-20">
7+
<title>BinaryPropertyListParser (dd-plist 1.21 API)</title>
8+
<meta name="date" content="2018-08-21">
99
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
1010
<script type="text/javascript" src="../../../script.js"></script>
1111
</head>
1212
<body>
1313
<script type="text/javascript"><!--
1414
try {
1515
if (location.href.indexOf('is-external=true') == -1) {
16-
parent.document.title="BinaryPropertyListParser (dd-plist 1.20 API)";
16+
parent.document.title="BinaryPropertyListParser (dd-plist 1.21 API)";
1717
}
1818
}
1919
catch(err) {
@@ -242,10 +242,10 @@ <h4>parse</h4>
242242
<dt><span class="paramLabel">Parameters:</span></dt>
243243
<dd><code>data</code> - The binary property list's data.</dd>
244244
<dt><span class="returnLabel">Returns:</span></dt>
245-
<dd>The root object of the property list. This is usually a {@link NSDictionary} but can also be a {@link NSArray}.</dd>
245+
<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>
246246
<dt><span class="throwsLabel">Throws:</span></dt>
247247
<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>
248-
<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>
248+
<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>
249249
</dl>
250250
</li>
251251
</ul>
@@ -258,15 +258,16 @@ <h4>parse</h4>
258258
<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)
259259
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>,
260260
<a href="../../../com/dd/plist/PropertyListFormatException.html" title="class in com.dd.plist">PropertyListFormatException</a></pre>
261-
<div class="block">Parses a binary property list from an input stream.</div>
261+
<div class="block">Parses a binary property list from an input stream.
262+
This method does not close the specified input stream.</div>
262263
<dl>
263264
<dt><span class="paramLabel">Parameters:</span></dt>
264265
<dd><code>is</code> - The input stream that points to the property list's data.</dd>
265266
<dt><span class="returnLabel">Returns:</span></dt>
266-
<dd>The root object of the property list. This is usually a {@link NSDictionary} but can also be a {@link NSArray}.</dd>
267+
<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>
267268
<dt><span class="throwsLabel">Throws:</span></dt>
268269
<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>
269-
<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>
270+
<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>
270271
</dl>
271272
</li>
272273
</ul>
@@ -284,11 +285,10 @@ <h4>parse</h4>
284285
<dt><span class="paramLabel">Parameters:</span></dt>
285286
<dd><code>f</code> - The binary property list file</dd>
286287
<dt><span class="returnLabel">Returns:</span></dt>
287-
<dd>The root object of the property list. This is usually a {@link NSDictionary} but can also be a {@link NSArray}.</dd>
288+
<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>
288289
<dt><span class="throwsLabel">Throws:</span></dt>
289290
<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>
290-
<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>
291-
<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>
291+
<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>
292292
</dl>
293293
</li>
294294
</ul>
@@ -488,6 +488,6 @@ <h4>copyOfRange</h4>
488488
<!-- -->
489489
</a></div>
490490
<!-- ======== END OF BOTTOM NAVBAR ======= -->
491-
<p class="legalCopy"><small>Copyright &#169; 2017. All Rights Reserved.</small></p>
491+
<p class="legalCopy"><small>Copyright &#169; 2018. All Rights Reserved.</small></p>
492492
</body>
493493
</html>

‎docs/com/dd/plist/BinaryPropertyListWriter.html

+10-9
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22
<!-- NewPage -->
33
<html lang="de">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_25) on Thu Jul 20 17:48:13 CEST 2017 -->
5+
<!-- Generated by javadoc (1.8.0_25) on Tue Aug 21 19:00:43 CEST 2018 -->
66
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7-
<title>BinaryPropertyListWriter (dd-plist 1.20 API)</title>
8-
<meta name="date" content="2017-07-20">
7+
<title>BinaryPropertyListWriter (dd-plist 1.21 API)</title>
8+
<meta name="date" content="2018-08-21">
99
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
1010
<script type="text/javascript" src="../../../script.js"></script>
1111
</head>
1212
<body>
1313
<script type="text/javascript"><!--
1414
try {
1515
if (location.href.indexOf('is-external=true') == -1) {
16-
parent.document.title="BinaryPropertyListWriter (dd-plist 1.20 API)";
16+
parent.document.title="BinaryPropertyListWriter (dd-plist 1.21 API)";
1717
}
1818
}
1919
catch(err) {
@@ -195,7 +195,7 @@ <h4>write</h4>
195195
<dd><code>file</code> - the file to write to</dd>
196196
<dd><code>root</code> - the source of the data to write to the file</dd>
197197
<dt><span class="throwsLabel">Throws:</span></dt>
198-
<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
198+
<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
199199
data that cannot be saved.</dd>
200200
</dl>
201201
</li>
@@ -209,13 +209,14 @@ <h4>write</h4>
209209
<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,
210210
<a href="../../../com/dd/plist/NSObject.html" title="class in com.dd.plist">NSObject</a>&nbsp;root)
211211
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>
212-
<div class="block">Writes a binary plist serialization of the given object as the root.</div>
212+
<div class="block">Writes a binary plist serialization of the given object as the root.
213+
This method does not close the output stream.</div>
213214
<dl>
214215
<dt><span class="paramLabel">Parameters:</span></dt>
215216
<dd><code>out</code> - the stream to write to</dd>
216217
<dd><code>root</code> - the source of the data to write to the stream</dd>
217218
<dt><span class="throwsLabel">Throws:</span></dt>
218-
<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
219+
<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
219220
data that cannot be saved.</dd>
220221
</dl>
221222
</li>
@@ -236,7 +237,7 @@ <h4>writeToArray</h4>
236237
<dt><span class="returnLabel">Returns:</span></dt>
237238
<dd>The byte array containing the serialized property list</dd>
238239
<dt><span class="throwsLabel">Throws:</span></dt>
239-
<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
240+
<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
240241
data that cannot be saved.</dd>
241242
</dl>
242243
</li>
@@ -309,6 +310,6 @@ <h4>writeToArray</h4>
309310
<!-- -->
310311
</a></div>
311312
<!-- ======== END OF BOTTOM NAVBAR ======= -->
312-
<p class="legalCopy"><small>Copyright &#169; 2017. All Rights Reserved.</small></p>
313+
<p class="legalCopy"><small>Copyright &#169; 2018. All Rights Reserved.</small></p>
313314
</body>
314315
</html>

0 commit comments

Comments
 (0)