mcatan 2004/05/08 06:12:26
Modified: include/log4cxx/helpers xml.h
Log:
added Documentation
Revision Changes Path
1.7 +25 -1 logging-log4cxx/include/log4cxx/helpers/xml.h
Index: xml.h
===================================================================
RCS file: /home/cvs/logging-log4cxx/include/log4cxx/helpers/xml.h,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- xml.h 24 Apr 2004 08:20:56 -0000 1.6
+++ xml.h 8 May 2004 13:12:26 -0000 1.7
@@ -42,6 +42,10 @@
{
};
+ /**
+ The XMLDOMNode interface is the primary datatype for the entire
Document
+ Object Model.
+ */
class LOG4CXX_EXPORT XMLDOMNode : virtual public Object
{
public:
@@ -58,15 +62,25 @@
virtual XMLDOMDocumentPtr getOwnerDocument() = 0;
};
+ /**
+ The XMLDOMDocument interface represents an entire XML document.
+
+ Conceptually, it is the root of the document tree, and provides
the
+ primary access to the document's data.
+ */
class LOG4CXX_EXPORT XMLDOMDocument : virtual public XMLDOMNode
{
public:
DECLARE_ABSTRACT_LOG4CXX_OBJECT(XMLDOMDocument)
virtual void load(const String& fileName) = 0;
virtual XMLDOMElementPtr getDocumentElement() = 0;
- virtual XMLDOMElementPtr getElementById(const String&
tagName, const String& elementId) = 0;
+ virtual XMLDOMElementPtr getElementById(const String&
tagName,
+ const String& elementId) = 0;
};
+ /**
+ The XMLDOMElement interface represents an element in an XML
document
+ */
class LOG4CXX_EXPORT XMLDOMElement : virtual public XMLDOMNode
{
public:
@@ -75,6 +89,16 @@
virtual String getAttribute(const String& name) = 0;
};
+ /**
+ The XMLDOMNodeList interface provides the abstraction of an
ordered
+ collection of nodes, without defining or constraining how this
+ collection is implemented.
+
+ XMLDOMNodeList objects in the DOM are live.
+
+ The items in the XMLDOMNodeList are accessible via an integral
index,
+ starting from 0.
+ */
class LOG4CXX_EXPORT XMLDOMNodeList : virtual public Object
{
public:
