aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNick Burch <nick@apache.org>2014-03-08 19:33:07 +0000
committerNick Burch <nick@apache.org>2014-03-08 19:33:07 +0000
commitb02504396b324317aaf8e5f06d4147f7a5ca165c (patch)
tree766b289bdde0ec2b9535b5f960d13a2ad2118241
parentb9cd5ca769009bb3dad5f18dd85ca0b71d7c4d7e (diff)
downloadpoi-b02504396b324317aaf8e5f06d4147f7a5ca165c.tar.gz
poi-b02504396b324317aaf8e5f06d4147f7a5ca165c.zip
Add some javadocs for the XWPF Header/Footer creation methods
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1575594 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java18
1 files changed, 18 insertions, 0 deletions
diff --git a/src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java b/src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java
index 1228a31ed8..a40e5992b0 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/model/XWPFHeaderFooterPolicy.java
@@ -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";