You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2016/05/31 15:08:51 UTC

svn commit: r1746287 - in /poi/site/publish/apidocs/org/apache/poi: sl/draw/ util/ util/class-use/

Author: nick
Date: Tue May 31 15:08:51 2016
New Revision: 1746287

URL: http://svn.apache.org/viewvc?rev=1746287&view=rev
Log:
Republish site

Modified:
    poi/site/publish/apidocs/org/apache/poi/sl/draw/DrawPaint.html
    poi/site/publish/apidocs/org/apache/poi/util/ByteField.html
    poi/site/publish/apidocs/org/apache/poi/util/FixedField.html
    poi/site/publish/apidocs/org/apache/poi/util/IntegerField.html
    poi/site/publish/apidocs/org/apache/poi/util/LittleEndianInputStream.html
    poi/site/publish/apidocs/org/apache/poi/util/LongField.html
    poi/site/publish/apidocs/org/apache/poi/util/RLEDecompressingInputStream.html
    poi/site/publish/apidocs/org/apache/poi/util/ShortField.html
    poi/site/publish/apidocs/org/apache/poi/util/StringUtil.html
    poi/site/publish/apidocs/org/apache/poi/util/Units.html
    poi/site/publish/apidocs/org/apache/poi/util/XMLHelper.html
    poi/site/publish/apidocs/org/apache/poi/util/class-use/LittleEndian.BufferUnderrunException.html

Modified: poi/site/publish/apidocs/org/apache/poi/sl/draw/DrawPaint.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/sl/draw/DrawPaint.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/sl/draw/DrawPaint.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/sl/draw/DrawPaint.html Tue May 31 15:08:51 2016
@@ -405,7 +405,8 @@ extends java.lang.Object</pre>
                      double&nbsp;l,
                      double&nbsp;alpha)</pre>
 <div class="block">Convert HSL values to a RGB Color.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>h</code> - Hue is specified as degrees in the range 0 - 360.</dd><dd><code>s</code> - Saturation is specified as a percentage in the range 1 - 100.</dd><dd><code>l</code> - Luminance is specified as a percentage in the range 1 - 100.</dd><dd><code>alpha</code> - the alpha value between 0 - 1</dd></dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>h</code> - Hue is specified as degrees in the range 0 - 360.</dd><dd><code>s</code> - Saturation is specified as a percentage in the range 1 - 100.</dd><dd><code>l</code> - Luminance is specified as a percentage in the range 1 - 100.</dd><dd><code>alpha</code> - the alpha value between 0 - 1</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the RGB Color object</dd></dl>
 </li>
 </ul>
 <a name="srgb2lin(float)">

Modified: poi/site/publish/apidocs/org/apache/poi/util/ByteField.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/ByteField.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/util/ByteField.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/util/ByteField.html Tue May 31 15:08:51 2016
@@ -370,8 +370,7 @@ implements <a href="../../../../org/apac
 <li class="blockList">
 <h4>readFromStream</h4>
 <pre>public&nbsp;void&nbsp;readFromStream(java.io.InputStream&nbsp;stream)
-                    throws java.io.IOException,
-                           <a href="../../../../org/apache/poi/util/LittleEndian.BufferUnderrunException.html" title="class in org.apache.poi.util">LittleEndian.BufferUnderrunException</a></pre>
+                    throws java.io.IOException</pre>
 <div class="block">set the value from an InputStream</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>

Modified: poi/site/publish/apidocs/org/apache/poi/util/FixedField.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/FixedField.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/util/FixedField.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/util/FixedField.html Tue May 31 15:08:51 2016
@@ -174,8 +174,7 @@
 <li class="blockList">
 <h4>readFromStream</h4>
 <pre>void&nbsp;readFromStream(java.io.InputStream&nbsp;stream)
-                    throws java.io.IOException,
-                           <a href="../../../../org/apache/poi/util/LittleEndian.BufferUnderrunException.html" title="class in org.apache.poi.util">LittleEndian.BufferUnderrunException</a></pre>
+                    throws java.io.IOException</pre>
 <div class="block">set the value from an InputStream</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>stream</code> - the InputStream from which the value is to be
                read</dd>

Modified: poi/site/publish/apidocs/org/apache/poi/util/IntegerField.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/IntegerField.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/util/IntegerField.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/util/IntegerField.html Tue May 31 15:08:51 2016
@@ -374,8 +374,7 @@ implements <a href="../../../../org/apac
 <li class="blockList">
 <h4>readFromStream</h4>
 <pre>public&nbsp;void&nbsp;readFromStream(java.io.InputStream&nbsp;stream)
-                    throws java.io.IOException,
-                           <a href="../../../../org/apache/poi/util/LittleEndian.BufferUnderrunException.html" title="class in org.apache.poi.util">LittleEndian.BufferUnderrunException</a></pre>
+                    throws java.io.IOException</pre>
 <div class="block">set the value from an InputStream</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>

Modified: poi/site/publish/apidocs/org/apache/poi/util/LittleEndianInputStream.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/LittleEndianInputStream.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/util/LittleEndianInputStream.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/util/LittleEndianInputStream.html Tue May 31 15:08:51 2016
@@ -342,8 +342,7 @@ implements <a href="../../../../org/apac
 <div class="block">get an unsigned int value from an InputStream</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>the unsigned int (32-bit) value</dd>
 <dt><span class="strong">Throws:</span></dt>
-<dd><code>java.io.IOException</code> - will be propagated back to the caller</dd>
-<dd><code><a href="../../../../org/apache/poi/util/LittleEndian.BufferUnderrunException.html" title="class in org.apache.poi.util">LittleEndian.BufferUnderrunException</a></code> - if the stream cannot provide enough bytes</dd></dl>
+<dd><code>java.lang.RuntimeException</code> - wraps any IOException thrown from reading the stream.</dd></dl>
 </li>
 </ul>
 <a name="readLong()">

Modified: poi/site/publish/apidocs/org/apache/poi/util/LongField.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/LongField.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/util/LongField.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/util/LongField.html Tue May 31 15:08:51 2016
@@ -369,8 +369,7 @@ implements <a href="../../../../org/apac
 <li class="blockList">
 <h4>readFromStream</h4>
 <pre>public&nbsp;void&nbsp;readFromStream(java.io.InputStream&nbsp;stream)
-                    throws java.io.IOException,
-                           <a href="../../../../org/apache/poi/util/LittleEndian.BufferUnderrunException.html" title="class in org.apache.poi.util">LittleEndian.BufferUnderrunException</a></pre>
+                    throws java.io.IOException</pre>
 <div class="block">set the value from an InputStream</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>

Modified: poi/site/publish/apidocs/org/apache/poi/util/RLEDecompressingInputStream.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/RLEDecompressingInputStream.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/util/RLEDecompressingInputStream.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/util/RLEDecompressingInputStream.html Tue May 31 15:08:51 2016
@@ -231,7 +231,7 @@ extends java.io.InputStream</pre>
 <pre>public&nbsp;RLEDecompressingInputStream(java.io.InputStream&nbsp;in)
                             throws java.io.IOException</pre>
 <div class="block">Creates a new wrapper RLE Decompression InputStream.</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - </dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - The stream to wrap with the RLE Decompression</dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code>java.io.IOException</code></dd></dl>
 </li>
@@ -372,8 +372,8 @@ extends java.io.InputStream</pre>
 <ul class="blockList">
 <li class="blockList">
 <h4>decompress</h4>
-<pre>public static final&nbsp;byte[]&nbsp;decompress(byte[]&nbsp;compressed)
-                               throws java.io.IOException</pre>
+<pre>public static&nbsp;byte[]&nbsp;decompress(byte[]&nbsp;compressed)
+                         throws java.io.IOException</pre>
 <dl><dt><span class="strong">Throws:</span></dt>
 <dd><code>java.io.IOException</code></dd></dl>
 </li>
@@ -384,10 +384,10 @@ extends java.io.InputStream</pre>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>decompress</h4>
-<pre>public static final&nbsp;byte[]&nbsp;decompress(byte[]&nbsp;compressed,
+<pre>public static&nbsp;byte[]&nbsp;decompress(byte[]&nbsp;compressed,
                 int&nbsp;offset,
                 int&nbsp;length)
-                               throws java.io.IOException</pre>
+                         throws java.io.IOException</pre>
 <dl><dt><span class="strong">Throws:</span></dt>
 <dd><code>java.io.IOException</code></dd></dl>
 </li>

Modified: poi/site/publish/apidocs/org/apache/poi/util/ShortField.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/ShortField.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/util/ShortField.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/util/ShortField.html Tue May 31 15:08:51 2016
@@ -369,8 +369,7 @@ implements <a href="../../../../org/apac
 <li class="blockList">
 <h4>readFromStream</h4>
 <pre>public&nbsp;void&nbsp;readFromStream(java.io.InputStream&nbsp;stream)
-                    throws java.io.IOException,
-                           <a href="../../../../org/apache/poi/util/LittleEndian.BufferUnderrunException.html" title="class in org.apache.poi.util">LittleEndian.BufferUnderrunException</a></pre>
+                    throws java.io.IOException</pre>
 <div class="block">set the value from an InputStream</div>
 <dl>
 <dt><strong>Specified by:</strong></dt>

Modified: poi/site/publish/apidocs/org/apache/poi/util/StringUtil.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/StringUtil.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/util/StringUtil.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/util/StringUtil.html Tue May 31 15:08:51 2016
@@ -653,7 +653,7 @@ extends java.lang.Object</pre>
 <h4>isUnicodeString</h4>
 <pre>public static&nbsp;boolean&nbsp;isUnicodeString(java.lang.String&nbsp;value)</pre>
 <div class="block">Checks to see if a given String needs to be represented as Unicode</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - </dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The string to look at.</dd>
 <dt><span class="strong">Returns:</span></dt><dd>true if string needs Unicode to be represented.</dd></dl>
 </li>
 </ul>

Modified: poi/site/publish/apidocs/org/apache/poi/util/Units.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/Units.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/util/Units.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/util/Units.html Tue May 31 15:08:51 2016
@@ -386,7 +386,7 @@ extends java.lang.Object</pre>
 <h4>fixedPointToDouble</h4>
 <pre>public static&nbsp;double&nbsp;fixedPointToDouble(int&nbsp;fixedPoint)</pre>
 <div class="block">Converts a value of type FixedPoint to a floating point</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fixedPoint</code> - </dd>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fixedPoint</code> - value in fixed point notation</dd>
 <dt><span class="strong">Returns:</span></dt><dd>floating point (double)</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a></dd></dl>
 </li>
 </ul>
@@ -398,8 +398,8 @@ extends java.lang.Object</pre>
 <h4>doubleToFixedPoint</h4>
 <pre>public static&nbsp;int&nbsp;doubleToFixedPoint(double&nbsp;floatPoint)</pre>
 <div class="block">Converts a value of type floating point to a FixedPoint</div>
-<dl><dt><span class="strong">Parameters:</span></dt><dd><code>floatPoint</code> - </dd>
-<dt><span class="strong">Returns:</span></dt><dd>fixedPoint</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a></dd></dl>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>floatPoint</code> - value in floating point notation</dd>
+<dt><span class="strong">Returns:</span></dt><dd>fixedPoint value in fixed points notation</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://msdn.microsoft.com/en-us/library/dd910765(v=office.12).aspx">[MS-OSHARED] - 2.2.1.6 FixedPoint</a></dd></dl>
 </li>
 </ul>
 <a name="masterToPoints(int)">

Modified: poi/site/publish/apidocs/org/apache/poi/util/XMLHelper.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/XMLHelper.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/util/XMLHelper.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/util/XMLHelper.html Tue May 31 15:08:51 2016
@@ -97,7 +97,6 @@
 <pre>public final class <span class="strong">XMLHelper</span>
 extends java.lang.Object</pre>
 <div class="block">Helper methods for working with javax.xml classes.</div>
-<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/poi/util/SAXHelper.html" title="class in org.apache.poi.util"><code>SAXHelper</code></a></dd></dl>
 </li>
 </ul>
 </div>

Modified: poi/site/publish/apidocs/org/apache/poi/util/class-use/LittleEndian.BufferUnderrunException.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/util/class-use/LittleEndian.BufferUnderrunException.html?rev=1746287&r1=1746286&r2=1746287&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/util/class-use/LittleEndian.BufferUnderrunException.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/util/class-use/LittleEndian.BufferUnderrunException.html Tue May 31 15:08:51 2016
@@ -126,60 +126,30 @@
 </tr>
 <tbody>
 <tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="strong">IntegerField.</span><code><strong><a href="../../../../../org/apache/poi/util/IntegerField.html#readFromStream(java.io.InputStream)">readFromStream</a></strong>(java.io.InputStream&nbsp;stream)</code>
-<div class="block">set the value from an InputStream</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="strong">LongField.</span><code><strong><a href="../../../../../org/apache/poi/util/LongField.html#readFromStream(java.io.InputStream)">readFromStream</a></strong>(java.io.InputStream&nbsp;stream)</code>
-<div class="block">set the value from an InputStream</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="strong">ByteField.</span><code><strong><a href="../../../../../org/apache/poi/util/ByteField.html#readFromStream(java.io.InputStream)">readFromStream</a></strong>(java.io.InputStream&nbsp;stream)</code>
-<div class="block">set the value from an InputStream</div>
-</td>
-</tr>
-<tr class="rowColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="strong">FixedField.</span><code><strong><a href="../../../../../org/apache/poi/util/FixedField.html#readFromStream(java.io.InputStream)">readFromStream</a></strong>(java.io.InputStream&nbsp;stream)</code>
-<div class="block">set the value from an InputStream</div>
-</td>
-</tr>
-<tr class="altColor">
-<td class="colFirst"><code>void</code></td>
-<td class="colLast"><span class="strong">ShortField.</span><code><strong><a href="../../../../../org/apache/poi/util/ShortField.html#readFromStream(java.io.InputStream)">readFromStream</a></strong>(java.io.InputStream&nbsp;stream)</code>
-<div class="block">set the value from an InputStream</div>
-</td>
-</tr>
-<tr class="rowColor">
 <td class="colFirst"><code>static int</code></td>
 <td class="colLast"><span class="strong">LittleEndian.</span><code><strong><a href="../../../../../org/apache/poi/util/LittleEndian.html#readInt(java.io.InputStream)">readInt</a></strong>(java.io.InputStream&nbsp;stream)</code>
 <div class="block">get an int value from an InputStream</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>static long</code></td>
 <td class="colLast"><span class="strong">LittleEndian.</span><code><strong><a href="../../../../../org/apache/poi/util/LittleEndian.html#readLong(java.io.InputStream)">readLong</a></strong>(java.io.InputStream&nbsp;stream)</code>
 <div class="block">get a long value from an InputStream</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>static short</code></td>
 <td class="colLast"><span class="strong">LittleEndian.</span><code><strong><a href="../../../../../org/apache/poi/util/LittleEndian.html#readShort(java.io.InputStream)">readShort</a></strong>(java.io.InputStream&nbsp;stream)</code>
 <div class="block">get a short value from an InputStream</div>
 </td>
 </tr>
-<tr class="altColor">
+<tr class="rowColor">
 <td class="colFirst"><code>static long</code></td>
 <td class="colLast"><span class="strong">LittleEndian.</span><code><strong><a href="../../../../../org/apache/poi/util/LittleEndian.html#readUInt(java.io.InputStream)">readUInt</a></strong>(java.io.InputStream&nbsp;stream)</code>
 <div class="block">get an unsigned int value from an InputStream</div>
 </td>
 </tr>
-<tr class="rowColor">
+<tr class="altColor">
 <td class="colFirst"><code>static int</code></td>
 <td class="colLast"><span class="strong">LittleEndian.</span><code><strong><a href="../../../../../org/apache/poi/util/LittleEndian.html#readUShort(java.io.InputStream)">readUShort</a></strong>(java.io.InputStream&nbsp;stream)</code>&nbsp;</td>
 </tr>



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org