Yate
XmlComment Class Reference

Xml Comment. More...

#include <yatexml.h>

Inheritance diagram for XmlComment:
XmlChild GenObject

Public Member Functions

 XmlComment (const String &comm)
 XmlComment (const XmlComment &orig)
virtual ~XmlComment ()
const StringgetComment () const
void toString (String &dump, const String &indent=String::empty()) const
virtual XmlCommentxmlComment ()
Public Member Functions inherited from XmlChild
 XmlChild ()
virtual void setParent (XmlParent *parent)
virtual XmlElementxmlElement ()
virtual XmlCDataxmlCData ()
virtual XmlTextxmlText ()
virtual XmlDeclarationxmlDeclaration ()
virtual XmlDoctypexmlDoctype ()
virtual void replaceParams (const NamedList &params)
Public Member Functions inherited from GenObject
 GenObject ()
virtual ~GenObject ()
virtual bool alive () const
virtual void destruct ()
virtual const StringtoString () const
virtual const StringtraceId () const
virtual void * getObject (const String &name) const
NamedCountergetObjCounter () const
NamedCountersetObjCounter (NamedCounter *counter)

Additional Inherited Members

Static Public Member Functions inherited from GenObject
static void * getObject (const String &name, const GenObject *obj)
static bool getObjCounting ()
static void setObjCounting (bool enable)
static NamedCountergetObjCounter (const String &name, bool create=true)
static ObjListgetObjCounters ()

Detailed Description

Xml Comment.

A Xml Comment from Xml document

Constructor & Destructor Documentation

◆ XmlComment() [1/2]

XmlComment ( const String & comm)

Constructor

Parameters
commThe comment content

Referenced by XmlComment(), and xmlComment().

◆ XmlComment() [2/2]

XmlComment ( const XmlComment & orig)

Copy constructor

Parameters
origOriginal XmlComment

References XmlComment().

◆ ~XmlComment()

virtual ~XmlComment ( )
virtual

Destructor

Member Function Documentation

◆ getComment()

const String & getComment ( ) const
inline

Get the text contained by this comment

Returns
The comment

◆ toString()

void toString ( String & dump,
const String & indent = String::empty() ) const

Build a String from this XmlComment

Parameters
dumpThe string where to append representation
indentSpaces for output

References String::empty().

◆ xmlComment()

virtual XmlComment * xmlComment ( )
inlinevirtual

Get the Xml comment

Returns
This object

Reimplemented from XmlChild.

References XmlComment().


The documentation for this class was generated from the following file: