Author: nick
Date: Sat Mar 8 19:33:07 2014
New Revision: 1575594
URL: http://svn.apache.org/r1575594
Log:
Add some javadocs for the XWPF Header/Footer creation methods
Modified:
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java
Modified:
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java?rev=1575594&r1=1575593&r2=1575594&view=diff
==============================================================================
---
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java
(original)
+++
poi/trunk/src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java
Sat Mar 8 19:33:07 2014
@@ -149,10 +149,19 @@ public class XWPFHeaderFooterPolicy {
}
}
+ /**
+ * Creates an empty header of the specified type, to
+ * which you can then create paragraphs and set text etc.
+ */
public XWPFHeader createHeader(Enum type) throws IOException {
return createHeader(type, null);
}
+ /**
+ * Creates a new header of the specified type, to which the
+ * supplied (and previously unattached!) paragraphs are
+ * added to.
+ */
public XWPFHeader createHeader(Enum type, XWPFParagraph[] pars) throws
IOException {
XWPFRelation relation = XWPFRelation.HEADER;
String pStyle = "Header";
@@ -174,10 +183,19 @@ public class XWPFHeaderFooterPolicy {
return wrapper;
}
+ /**
+ * Creates an empty footer of the specified type, to
+ * which you can then create paragraphs and set text etc.
+ */
public XWPFFooter createFooter(Enum type) throws IOException {
return createFooter(type, null);
}
+ /**
+ * Creates a new footer of the specified type, to which the
+ * supplied (and previously unattached!) paragraphs are
+ * added to.
+ */
public XWPFFooter createFooter(Enum type, XWPFParagraph[] pars) throws
IOException {
XWPFRelation relation = XWPFRelation.FOOTER;
String pStyle = "Footer";
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
