From b02504396b324317aaf8e5f06d4147f7a5ca165c Mon Sep 17 00:00:00 2001
From: Nick Burch <nick@apache.org>
Date: Sat, 8 Mar 2014 19:33:07 +0000
Subject: [PATCH] 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
---
 .../poi/xwpf/model/XWPFHeaderFooterPolicy.java | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

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";