Author: nick
Date: Wed Aug 12 14:14:30 2015
New Revision: 1695529
URL: http://svn.apache.org/r1695529
Log:
Javadocs updates
Modified:
poi/site/publish/apidocs/index-all.html
poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Font.html
poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFFont.html
poi/site/publish/changes.html
poi/site/publish/changes.rss
poi/site/src/documentation/content/xdocs/status.xml
Modified: poi/site/publish/apidocs/index-all.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/apidocs/index-all.html?rev=1695529&r1=1695528&r2=1695529&view=diff
==============================================================================
--- poi/site/publish/apidocs/index-all.html (original)
+++ poi/site/publish/apidocs/index-all.html Wed Aug 12 14:14:30 2015
@@ -26034,7 +26034,7 @@
</dd>
<dt><span class="strong"><a
href="./org/apache/poi/ss/usermodel/Font.html#getFontHeight()">getFontHeight()</a></span>
- Method in interface org.apache.poi.ss.usermodel.<a
href="./org/apache/poi/ss/usermodel/Font.html" title="interface in
org.apache.poi.ss.usermodel">Font</a></dt>
<dd>
-<div class="block">get the font height in unit's of 1/20th of a point.</div>
+<div class="block">Get the font height in unit's of 1/20th of a point.</div>
</dd>
<dt><span class="strong"><a
href="./org/apache/poi/ss/usermodel/FontFormatting.html#getFontHeight()">getFontHeight()</a></span>
- Method in interface org.apache.poi.ss.usermodel.<a
href="./org/apache/poi/ss/usermodel/FontFormatting.html" title="interface in
org.apache.poi.ss.usermodel">FontFormatting</a></dt>
<dd>
@@ -26042,7 +26042,7 @@
</dd>
<dt><span class="strong"><a
href="./org/apache/poi/xssf/usermodel/XSSFFont.html#getFontHeight()">getFontHeight()</a></span>
- Method in class org.apache.poi.xssf.usermodel.<a
href="./org/apache/poi/xssf/usermodel/XSSFFont.html" title="class in
org.apache.poi.xssf.usermodel">XSSFFont</a></dt>
<dd>
-<div class="block">get the font height in point.</div>
+<div class="block">Get the font height in unit's of 1/20th of a point.</div>
</dd>
<dt><span class="strong"><a
href="./org/apache/poi/xssf/usermodel/XSSFFontFormatting.html#getFontHeight()">getFontHeight()</a></span>
- Method in class org.apache.poi.xssf.usermodel.<a
href="./org/apache/poi/xssf/usermodel/XSSFFontFormatting.html" title="class in
org.apache.poi.xssf.usermodel">XSSFFontFormatting</a></dt>
<dd>
@@ -26054,10 +26054,12 @@
</dd>
<dt><span class="strong"><a
href="./org/apache/poi/ss/usermodel/Font.html#getFontHeightInPoints()">getFontHeightInPoints()</a></span>
- Method in interface org.apache.poi.ss.usermodel.<a
href="./org/apache/poi/ss/usermodel/Font.html" title="interface in
org.apache.poi.ss.usermodel">Font</a></dt>
<dd>
-<div class="block">get the font height</div>
+<div class="block">Get the font height in points.</div>
</dd>
<dt><span class="strong"><a
href="./org/apache/poi/xssf/usermodel/XSSFFont.html#getFontHeightInPoints()">getFontHeightInPoints()</a></span>
- Method in class org.apache.poi.xssf.usermodel.<a
href="./org/apache/poi/xssf/usermodel/XSSFFont.html" title="class in
org.apache.poi.xssf.usermodel">XSSFFont</a></dt>
-<dd> </dd>
+<dd>
+<div class="block">Get the font height in points.</div>
+</dd>
<dt><span class="strong"><a
href="./org/apache/poi/hslf/record/FontCollection.html#getFontIndex(java.lang.String)">getFontIndex(String)</a></span>
- Method in class org.apache.poi.hslf.record.<a
href="./org/apache/poi/hslf/record/FontCollection.html" title="class in
org.apache.poi.hslf.record">FontCollection</a></dt>
<dd> </dd>
<dt><span class="strong"><a
href="./org/apache/poi/hslf/record/FontEntityAtom.html#getFontIndex()">getFontIndex()</a></span>
- Method in class org.apache.poi.hslf.record.<a
href="./org/apache/poi/hslf/record/FontEntityAtom.html" title="class in
org.apache.poi.hslf.record">FontEntityAtom</a></dt>
Modified: poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Font.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Font.html?rev=1695529&r1=1695528&r2=1695529&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Font.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/ss/usermodel/Font.html Wed Aug 12
14:14:30 2015
@@ -237,13 +237,13 @@
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a
href="../../../../../org/apache/poi/ss/usermodel/Font.html#getFontHeight()">getFontHeight</a></strong>()</code>
-<div class="block">get the font height in unit's of 1/20th of a point.</div>
+<div class="block">Get the font height in unit's of 1/20th of a point.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a
href="../../../../../org/apache/poi/ss/usermodel/Font.html#getFontHeightInPoints()">getFontHeightInPoints</a></strong>()</code>
-<div class="block">get the font height</div>
+<div class="block">Get the font height in points.</div>
</td>
</tr>
<tr class="altColor">
@@ -590,8 +590,11 @@
<li class="blockList">
<h4>getFontHeight</h4>
<pre>short getFontHeight()</pre>
-<div class="block">get the font height in unit's of 1/20th of a point. Maybe
you might want to
- use the getFontHeightInPoints which matches to the familiar 10, 12, 14
etc..</div>
+<div class="block">Get the font height in unit's of 1/20th of a point.
+ <p>
+ For many users, the related <a
href="../../../../../org/apache/poi/ss/usermodel/Font.html#getFontHeightInPoints()"><code>getFontHeightInPoints()</code></a>
+ will be more helpful, as that returns font heights in the
+ more familiar points units, eg 10, 12, 14.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>short - height in 1/20ths
of a point</dd><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../org/apache/poi/ss/usermodel/Font.html#getFontHeightInPoints()"><code>getFontHeightInPoints()</code></a></dd></dl>
</li>
</ul>
@@ -602,7 +605,10 @@
<li class="blockList">
<h4>getFontHeightInPoints</h4>
<pre>short getFontHeightInPoints()</pre>
-<div class="block">get the font height</div>
+<div class="block">Get the font height in points.
+ <p>
+ This will return the same font height that is shown in Excel,
+ such as 10 or 14 or 28.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>short - height in the
familiar unit of measure - points</dd><dt><span class="strong">See
Also:</span></dt><dd><a
href="../../../../../org/apache/poi/ss/usermodel/Font.html#getFontHeight()"><code>getFontHeight()</code></a></dd></dl>
</li>
</ul>
Modified: poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFFont.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFFont.html?rev=1695529&r1=1695528&r2=1695529&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFFont.html
(original)
+++ poi/site/publish/apidocs/org/apache/poi/xssf/usermodel/XSSFFont.html Wed
Aug 12 14:14:30 2015
@@ -238,13 +238,13 @@ implements <a href="../../../../../org/a
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a
href="../../../../../org/apache/poi/xssf/usermodel/XSSFFont.html#getFontHeight()">getFontHeight</a></strong>()</code>
-<div class="block">get the font height in point.</div>
+<div class="block">Get the font height in unit's of 1/20th of a point.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a
href="../../../../../org/apache/poi/xssf/usermodel/XSSFFont.html#getFontHeightInPoints()">getFontHeightInPoints</a></strong>()</code>
-<div class="block">get the font height</div>
+<div class="block">Get the font height in points.</div>
</td>
</tr>
<tr class="rowColor">
@@ -633,11 +633,15 @@ public org.openxmlformats.schemas.s
<li class="blockList">
<h4>getFontHeight</h4>
<pre>public short getFontHeight()</pre>
-<div class="block">get the font height in point.</div>
+<div class="block">Get the font height in unit's of 1/20th of a point.
+ <p>
+ For many users, the related <a
href="../../../../../org/apache/poi/xssf/usermodel/XSSFFont.html#getFontHeightInPoints()"><code>getFontHeightInPoints()</code></a>
+ will be more helpful, as that returns font heights in the
+ more familiar points units, eg 10, 12, 14.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a
href="../../../../../org/apache/poi/ss/usermodel/Font.html#getFontHeight()">getFontHeight</a></code> in
interface <code><a
href="../../../../../org/apache/poi/ss/usermodel/Font.html" title="interface in
org.apache.poi.ss.usermodel">Font</a></code></dd>
-<dt><span class="strong">Returns:</span></dt><dd>short - height in
point</dd><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../org/apache/poi/ss/usermodel/Font.html#getFontHeightInPoints()"><code>Font.getFontHeightInPoints()</code></a></dd></dl>
+<dt><span class="strong">Returns:</span></dt><dd>short - height in 1/20ths of
a point</dd><dt><span class="strong">See Also:</span></dt><dd><a
href="../../../../../org/apache/poi/xssf/usermodel/XSSFFont.html#getFontHeightInPoints()"><code>getFontHeightInPoints()</code></a></dd></dl>
</li>
</ul>
<a name="getFontHeightInPoints()">
@@ -647,8 +651,10 @@ public org.openxmlformats.schemas.s
<li class="blockList">
<h4>getFontHeightInPoints</h4>
<pre>public short getFontHeightInPoints()</pre>
-<div class="block"><strong>Description copied from interface: <code><a
href="../../../../../org/apache/poi/ss/usermodel/Font.html#getFontHeightInPoints()">Font</a></code></strong></div>
-<div class="block">get the font height</div>
+<div class="block">Get the font height in points.
+ <p>
+ This will return the same font height that is shown in Excel,
+ such as 10 or 14 or 28.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a
href="../../../../../org/apache/poi/ss/usermodel/Font.html#getFontHeightInPoints()">getFontHeightInPoints</a></code> in
interface <code><a
href="../../../../../org/apache/poi/ss/usermodel/Font.html" title="interface in
org.apache.poi.ss.usermodel">Font</a></code></dd>
Modified: poi/site/publish/changes.html
URL:
http://svn.apache.org/viewvc/poi/site/publish/changes.html?rev=1695529&r1=1695528&r2=1695529&view=diff
==============================================================================
--- poi/site/publish/changes.html (original)
+++ poi/site/publish/changes.html Wed Aug 12 14:14:30 2015
@@ -261,6 +261,9 @@ if (VERSION > 3) {
<ul>
<li>
+<img class="icon" alt="fix" src="images/fix.jpg"> <a
href="https://bz.apache.org/bugzilla/show_bug.cgi?id=58220";>58220</a> - Improve
the javadocs for XSSFFont and Font getFontHeight methods</li>
+
+<li>
<img class="icon" alt="fix" src="images/fix.jpg"> <a
href="https://bz.apache.org/bugzilla/show_bug.cgi?id=56519";>56519</a> -
XSLFSlide.draw is not working with text embeded in PPTX</li>
<li>
@@ -318,6 +321,9 @@ if (VERSION > 3) {
<ul>
<li>
+<img class="icon" alt="add" src="images/add.jpg"> <a
href="https://bz.apache.org/bugzilla/show_bug.cgi?id=56791";>56791</a> - The
default POIFS implementation has been switched to NPOIFS. If you request a
POIFSFileSystem, you will now get a NPOIFSFileSystem-based one.
OPOIFSFileSystem remains for those who still want the old implementation</li>
+
+<li>
<img class="icon" alt="add" src="images/add.jpg"> <a
href="https://bz.apache.org/bugzilla/show_bug.cgi?id=58138";>58138</a> -
Conditional Formatting support for the common Color class, in addition to
previous color shorts</li>
<li>
Modified: poi/site/publish/changes.rss
URL:
http://svn.apache.org/viewvc/poi/site/publish/changes.rss?rev=1695529&r1=1695528&r2=1695529&view=diff
==============================================================================
--- poi/site/publish/changes.rss (original)
+++ poi/site/publish/changes.rss Wed Aug 12 14:14:30 2015
@@ -1,3 +1,3 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE rss PUBLIC "-//Netscape Communications//DTD RSS 0.91//EN"
"http://my.netscape.com/publish/formats/rss-0.91.dtd";>
-<rss version="0.91"><channel><title>POI
Changes</title><link>http://poi.apache.org/changes.html</link><description>POI
Changes</description><language>en-us</language><item><title> fix(bug
56519)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 56519) - XSLFSlide.draw is not working with text embeded
in PPTX</description></item><item><title> fix(bug
58205)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58205) - getSlideMasters() returns the master slides in
the incorrect order</description></item><item><title> fix(bug
57786)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 57786) - XSLFFreeformShape ignores quadratic bezier
curves</description></item><item><title> fix(bug
58206)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58206) - provide a mechanism to find slide layouts by
name</description></i
tem><item><title> fix(bug
58204)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58204) - STYLE: ShapeContainer interface makes internal
getShapesList() redundant</description></item><item><title> add(bug
58190)</title><link>http://poi.apache.org/changes.html</link><description> add
by POI Developers (bug 58190) - The current picture handling uses raw integers
for types and index, replace with enum and
reference</description></item><item><title> fix(bug
58203)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58203) - Apparently Maven uses plurals for all artifacts
except javadocs, so tweak our naming to make it
happy</description></item><item><title> add(bug
58193)</title><link>http://poi.apache.org/changes.html</link><description> add
by POI Developers (bug 58193) - Use input stream rather than byte array for
checksum etc.</description></item><item><title> add(bug
58200)</title><link>http:/
/poi.apache.org/changes.html</link><description> add by POI Developers (bug
58200) - SXSSF support for evaluating formula cells, provided the cell and all
its references are within the current window</description></item><item><title>
fix(bug
58098)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58098) - Avoid NPE in cleanup if NPOIFSFileSystem is
opened on a locked File under Windows</description></item><item><title>
add</title><link>http://poi.apache.org/changes.html</link><description> add by
POI Developers - Merged common_sl branch to
trunk</description></item><item><title> fix(bug
57571)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 57571) - Fix creating comments for XSSF/SXSSF,
regression was introduced via bug 54920</description></item><item><title>
fix(bug
58175)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58175) - Fix creating co
mments for XSSF/SXSSF, regression was introduced via bug
54920</description></item><item><title> fix(bug
58156)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58156) - Possible data corruption in hasPOIFSHeader and
hasOOXMLHeader</description></item><item><title> add(bug
57484)</title><link>http://poi.apache.org/changes.html</link><description> add
by POI Developers (bug 57484) - Allow processing of non-OOXML core namespace
packages</description></item><item><title> add(bug
58130)</title><link>http://poi.apache.org/changes.html</link><description> add
by POI Developers (bug 58130) - Conditional Formatting support for DataBars,
Icon Sets / Multi-States, and Color Scales</description></item></channel></rss>
\ No newline at end of file
+<rss version="0.91"><channel><title>POI
Changes</title><link>http://poi.apache.org/changes.html</link><description>POI
Changes</description><language>en-us</language><item><title> fix(bug
58220)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58220) - Improve the javadocs for XSSFFont and Font
getFontHeight methods</description></item><item><title> fix(bug
56519)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 56519) - XSLFSlide.draw is not working with text embeded
in PPTX</description></item><item><title> fix(bug
58205)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58205) - getSlideMasters() returns the master slides in
the incorrect order</description></item><item><title> fix(bug
57786)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 57786) - XSLFFreeformShape ignores quadratic bezier
curves</
description></item><item><title> fix(bug
58206)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58206) - provide a mechanism to find slide layouts by
name</description></item><item><title> fix(bug
58204)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58204) - STYLE: ShapeContainer interface makes internal
getShapesList() redundant</description></item><item><title> add(bug
58190)</title><link>http://poi.apache.org/changes.html</link><description> add
by POI Developers (bug 58190) - The current picture handling uses raw integers
for types and index, replace with enum and
reference</description></item><item><title> fix(bug
58203)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58203) - Apparently Maven uses plurals for all artifacts
except javadocs, so tweak our naming to make it
happy</description></item><item><title> add(bug 58193)</title><link
>http://poi.apache.org/changes.html</link><description> add by POI Developers
>(bug 58193) - Use input stream rather than byte array for checksum
>etc.</description></item><item><title> add(bug
>58200)</title><link>http://poi.apache.org/changes.html</link><description>
>add by POI Developers (bug 58200) - SXSSF support for evaluating formula
>cells, provided the cell and all its references are within the current
>window</description></item><item><title> fix(bug
>58098)</title><link>http://poi.apache.org/changes.html</link><description>
>fix by POI Developers (bug 58098) - Avoid NPE in cleanup if NPOIFSFileSystem
>is opened on a locked File under Windows</description></item><item><title>
>add</title><link>http://poi.apache.org/changes.html</link><description> add
>by POI Developers - Merged common_sl branch to
>trunk</description></item><item><title> fix(bug
>57571)</title><link>http://poi.apache.org/changes.html</link><description>
>fix by POI Developers (bug 57571) - Fix creating comments for XS
SF/SXSSF, regression was introduced via bug
54920</description></item><item><title> fix(bug
58175)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58175) - Fix creating comments for XSSF/SXSSF,
regression was introduced via bug 54920</description></item><item><title>
fix(bug
58156)</title><link>http://poi.apache.org/changes.html</link><description> fix
by POI Developers (bug 58156) - Possible data corruption in hasPOIFSHeader and
hasOOXMLHeader</description></item><item><title> add(bug
57484)</title><link>http://poi.apache.org/changes.html</link><description> add
by POI Developers (bug 57484) - Allow processing of non-OOXML core namespace
packages</description></item><item><title> add(bug
58130)</title><link>http://poi.apache.org/changes.html</link><description> add
by POI Developers (bug 58130) - Conditional Formatting support for DataBars,
Icon Sets / Multi-States, and Color Scales</description></item></channel></rss>
\ No newline at end of file
Modified: poi/site/src/documentation/content/xdocs/status.xml
URL:
http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/status.xml?rev=1695529&r1=1695528&r2=1695529&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/status.xml (original)
+++ poi/site/src/documentation/content/xdocs/status.xml Wed Aug 12 14:14:30 2015
@@ -39,6 +39,7 @@
</devs>
<release version="3.13-beta2" date="2015-10-??">
+ <action dev="PD" type="fix" fixes-bug="58220">Improve the javadocs for
XSSFFont and Font getFontHeight methods</action>
<action dev="PD" type="fix" fixes-bug="56519">XSLFSlide.draw is not
working with text embeded in PPTX</action>
<action dev="PD" type="fix" fixes-bug="58205">getSlideMasters()
returns the master slides in the incorrect order</action>
<action dev="PD" type="fix" fixes-bug="57786">XSLFFreeformShape
ignores quadratic bezier curves</action>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
