[Libreoffice-commits] .: Branch 'feature/calc-xml-source' - sc/inc

[Libreoffice Gerrit user]

 sc/inc/orcusfilters.hxx |    9 +++++++++
 1 file changed, 9 insertions(+)

New commits:
commit bb09627230584b6f4847f54ac431bfd4d328018b
Author: Kohei Yoshida <kohei.yoshida at gmail.com>
Date:   Mon Nov 19 16:56:24 2012 -0500

    Method description.
    
    Change-Id: I754ef846c3bc2d032a818dce6c223da89b3f8ccd

diff --git a/sc/inc/orcusfilters.hxx b/sc/inc/orcusfilters.hxx
index dd9778d..ee8d3f8 100644
--- a/sc/inc/orcusfilters.hxx
+++ b/sc/inc/orcusfilters.hxx
@@ -29,6 +29,15 @@ public:
 
     virtual bool importCSV(ScDocument& rDoc, const rtl::OUString& rPath) const = 0;
 
+    /**
+     * Create a context for XML file.  The context object stores session
+     * information for each unique XML file.  You must create a new context
+     * for each XML file, and never to re-use the same context for multiple
+     * XML files.
+     *
+     * The caller is responsible for deleting the instance returned from this
+     * method when it's done.
+     */
     virtual ScOrcusXMLContext* createXMLContext(ScDocument& rDoc, const rtl::OUString& rPath) const = 0;
 };