summaryrefslogtreecommitdiff
path: root/include/xmloff
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2017-10-17 17:48:11 +0200
committerMichael Stahl <mstahl@redhat.com>2017-10-17 21:10:08 +0200
commitdc8c9d8052293055f31b56fcd5db56ce13306a65 (patch)
tree9330d7890801362c653e4a30566f9b891a3b4bcb /include/xmloff
parent99772908d741c39236f36b06e237810031b8851a (diff)
xmloff: document return value
Change-Id: I0b2012d2134a94603d95ce5a955f03944e344561
Diffstat (limited to 'include/xmloff')
-rw-r--r--include/xmloff/xmlprhdl.hxx10
1 files changed, 7 insertions, 3 deletions
diff --git a/include/xmloff/xmlprhdl.hxx b/include/xmloff/xmlprhdl.hxx
index 0aba91b432f4..9c9a6f79b8de 100644
--- a/include/xmloff/xmlprhdl.hxx
+++ b/include/xmloff/xmlprhdl.hxx
@@ -36,7 +36,6 @@ struct XMLPropertyState;
*/
class XMLOFF_DLLPUBLIC XMLPropertyHandler
{
- // ??? const SvXMLUnitConverter& rUnitConverter Do we need this ?
public:
// Just needed for virtual destruction
@@ -46,9 +45,14 @@ public:
By default the Any-equal-operator is called. */
virtual bool equals( const css::uno::Any& r1, const css::uno::Any& r2 ) const;
- /// Imports the given value in cas of the given XML-data-type
+ /** Imports the given value according to the XML-data-type corresponding to
+ the derived class.
+ @retval true if the value was successfully converted to Any
+ @retval false if the value was not recognised (warning will be printed)
+ */
virtual bool importXML( const OUString& rStrImpValue, css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const =0;
- /// Exports the given value in case of the given XML-data-type
+ /// Exports the given value according to the XML-data-type corresponding to
+ /// the derived class.
virtual bool exportXML( OUString& rStrExpValue, const css::uno::Any& rValue, const SvXMLUnitConverter& rUnitConverter ) const =0;
};