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 2013/06/13 20:18:34 UTC
svn commit: r1492798 - in /poi/site/publish: apidocs/index-all.html
apidocs/org/apache/poi/xwpf/usermodel/BodyType.html
apidocs/org/apache/poi/xwpf/usermodel/package-summary.html
apidocs/org/apache/poi/xwpf/usermodel/package-use.html guidelines.html
Author: nick
Date: Thu Jun 13 18:18:34 2013
New Revision: 1492798
URL: http://svn.apache.org/r1492798
Log:
Republish the site
Modified:
poi/site/publish/apidocs/index-all.html
poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/BodyType.html
poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/package-summary.html
poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/package-use.html
poi/site/publish/guidelines.html
Modified: poi/site/publish/apidocs/index-all.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/index-all.html?rev=1492798&r1=1492797&r2=1492798&view=diff
==============================================================================
--- poi/site/publish/apidocs/index-all.html (original)
+++ poi/site/publish/apidocs/index-all.html Thu Jun 13 18:18:34 2013
@@ -2482,8 +2482,7 @@ Variable in class org.apache.poi.xwpf.us
Variable in class org.apache.poi.xwpf.usermodel.<A HREF="./org/apache/poi/xwpf/usermodel/XWPFTableCell.html" title="class in org.apache.poi.xwpf.usermodel">XWPFTableCell</A>
<DD>
<DT><A HREF="./org/apache/poi/xwpf/usermodel/BodyElementType.html" title="enum in org.apache.poi.xwpf.usermodel"><B>BodyElementType</B></A> - Enum in <A HREF="./org/apache/poi/xwpf/usermodel/package-summary.html">org.apache.poi.xwpf.usermodel</A><DD>
- 9 Jan 2010<DT><A HREF="./org/apache/poi/xwpf/usermodel/BodyType.html" title="enum in org.apache.poi.xwpf.usermodel"><B>BodyType</B></A> - Enum in <A HREF="./org/apache/poi/xwpf/usermodel/package-summary.html">org.apache.poi.xwpf.usermodel</A><DD>
- 9 Jan 2010<DT><A HREF="./org/apache/poi/hssf/record/BOFRecord.html" title="class in org.apache.poi.hssf.record"><B>BOFRecord</B></A> - Class in <A HREF="./org/apache/poi/hssf/record/package-summary.html">org.apache.poi.hssf.record</A><DD>Title: Beginning Of File (0x0809)<DT><A HREF="./org/apache/poi/hssf/record/BOFRecord.html#BOFRecord()"><B>BOFRecord()</B></A> -
+ 9 Jan 2010<DT><A HREF="./org/apache/poi/xwpf/usermodel/BodyType.html" title="enum in org.apache.poi.xwpf.usermodel"><B>BodyType</B></A> - Enum in <A HREF="./org/apache/poi/xwpf/usermodel/package-summary.html">org.apache.poi.xwpf.usermodel</A><DD>The different kinds of <A HREF="./org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel"><CODE>IBody</CODE></A> that exist<DT><A HREF="./org/apache/poi/hssf/record/BOFRecord.html" title="class in org.apache.poi.hssf.record"><B>BOFRecord</B></A> - Class in <A HREF="./org/apache/poi/hssf/record/package-summary.html">org.apache.poi.hssf.record</A><DD>Title: Beginning Of File (0x0809)<DT><A HREF="./org/apache/poi/hssf/record/BOFRecord.html#BOFRecord()"><B>BOFRecord()</B></A> -
Constructor for class org.apache.poi.hssf.record.<A HREF="./org/apache/poi/hssf/record/BOFRecord.html" title="class in org.apache.poi.hssf.record">BOFRecord</A>
<DD>Constructs an empty BOFRecord with no fields set.
<DT><A HREF="./org/apache/poi/hssf/record/BOFRecord.html#BOFRecord(org.apache.poi.hssf.record.RecordInputStream)"><B>BOFRecord(RecordInputStream)</B></A> -
Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/BodyType.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/BodyType.html?rev=1492798&r1=1492797&r2=1492798&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/BodyType.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/BodyType.html Thu Jun 13 18:18:34 2013
@@ -103,19 +103,10 @@ java.lang.Object
</PRE>
<P>
-<p>
- 9 Jan 2010
- </p>
- <p>
- // TODO insert Javadoc here!
- </p>
+The different kinds of <A HREF="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel"><CODE>IBody</CODE></A> that exist
<P>
<P>
-<DL>
-<DT><B>Author:</B></DT>
- <DD>epp</DD>
-</DL>
<HR>
<P>
Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/package-summary.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/package-summary.html?rev=1492798&r1=1492797&r2=1492798&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/package-summary.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/package-summary.html Thu Jun 13 18:18:34 2013
@@ -242,8 +242,7 @@ Package org.apache.poi.xwpf.usermodel
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/poi/xwpf/usermodel/BodyType.html" title="enum in org.apache.poi.xwpf.usermodel">BodyType</A></B></TD>
-<TD>
- 9 Jan 2010</TD>
+<TD>The different kinds of <A HREF="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel"><CODE>IBody</CODE></A> that exist</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD WIDTH="15%"><B><A HREF="../../../../../org/apache/poi/xwpf/usermodel/Borders.html" title="enum in org.apache.poi.xwpf.usermodel">Borders</A></B></TD>
Modified: poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/package-use.html
URL: http://svn.apache.org/viewvc/poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/package-use.html?rev=1492798&r1=1492797&r2=1492798&view=diff
==============================================================================
--- poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/package-use.html (original)
+++ poi/site/publish/apidocs/org/apache/poi/xwpf/usermodel/package-use.html Thu Jun 13 18:18:34 2013
@@ -175,8 +175,7 @@ Classes in <A HREF="../../../../../org/a
<TD><B><A HREF="../../../../../org/apache/poi/xwpf/usermodel/class-use/BodyType.html#org.apache.poi.xwpf.usermodel"><B>BodyType</B></A></B>
<BR>
-
- 9 Jan 2010</TD>
+ The different kinds of <A HREF="../../../../../org/apache/poi/xwpf/usermodel/IBody.html" title="interface in org.apache.poi.xwpf.usermodel"><CODE>IBody</CODE></A> that exist</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><B><A HREF="../../../../../org/apache/poi/xwpf/usermodel/class-use/Borders.html#org.apache.poi.xwpf.usermodel"><B>Borders</B></A></B>
Modified: poi/site/publish/guidelines.html
URL: http://svn.apache.org/viewvc/poi/site/publish/guidelines.html?rev=1492798&r1=1492797&r2=1492798&view=diff
==============================================================================
--- poi/site/publish/guidelines.html (original)
+++ poi/site/publish/guidelines.html Thu Jun 13 18:18:34 2013
@@ -269,6 +269,10 @@ if (VERSION > 3) {
</li>
<li>
+<a href="#CodeStyle">Code Style</a>
+</li>
+
+<li>
<a href="#Mentoring">Mentoring and Committership</a>
</li>
@@ -277,7 +281,7 @@ if (VERSION > 3) {
<a name="Introduction"></a>
- <a name="Introduction-N10038"></a>
+ <a name="Introduction-N1003D"></a>
<div class="h3">
<h3>Introduction</h3>
</div>
@@ -478,6 +482,14 @@ if (VERSION > 3) {
Software Foundation projects, do please try to submit early and often, rather
than "throwing a large patch over the wall" at the end.
</p>
+
+<p>
+ A number of Apache projects provide far more comprehensive guides to producing
+ and submitting patches than we do, you may wish to review some of their
+ information if you're unsure. The
+ <a href="http://commons.apache.org/patches.html">Apache Commons</a> one
+ is fairly similar as a starting point.
+ </p>
<p>You may create your patch file using either of the following approaches (the committers recommend the first):</p>
@@ -558,7 +570,7 @@ if (VERSION > 3) {
<li>the code does not depend on gpl or lgpl code.</li>
-<li>the code includes the @author tag on any files you've altered or created.</li>
+<li>the code doesn't include @author tags</li>
<li>existing test cases succeed.</li>
@@ -568,17 +580,50 @@ if (VERSION > 3) {
<li>diff files generated using svn diff</li>
-<li>message to dev contains [patch], task name and patch reason in subject.</li>
+<li>the bugzilla subject dev contains [patch], task name and patch reason in subject.</li>
-<li>message body contains a rationale for the patch.</li>
+<li>the bugzilla description contains a rationale for the patch.</li>
-<li>message attachment contains the patch file(s).</li>
+<li>attachment to the bugzilla entry contains the patch file(s).</li>
</ul>
+<a name="CodeStyle"></a>
+ <a name="Code+Style"></a>
+<div class="h3">
+<h3>Code Style</h3>
+</div>
+
+<p>The long standing
+ <a href="http://poi.apache.org/resolutions/res001.html">Minimal
+ Coding Standards</a> from 2002 still largely apply to the project.</p>
+
+<p>When making changes to an existing file, please try to follow the
+ same style that that file already uses. This will keep things
+ looking similar, and will prevent patches becoming largely about
+ whitespace. Whitespace fixing changes, if needed, should normally be
+ in their own commit, so that they don't crowd out coding changes
+ in review.</p>
+
+<p>Normally, tabs should not be used to indent code. Instead, spaces
+ should be used. If starting on a fresh file, please use 4 spaces to
+ indent your code. If working on an existing file, please use
+ whichever of 3 or 4 spaces that file already follows.</p>
+
+<p>Normally, braces should open on the same line as the decision
+ statement. Braces should normally close on their own line. Brackets
+ should normally have a space before them when they are the first.</p>
+
+<p>Lines normally shouldn't be too long. There's no hard and fast rule,
+ but if you line is getting above about 90 characters think about
+ splitting it, and you should rarely create something over about 100
+ characters without a very good reason!</p>
+
+
+
<a name="Mentoring"></a>
<a name="Mentoring+and+Committership"></a>
<div class="h3">
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org