From 1a8ec165031af3b860028ef1b360acc8e7baf9e6 Mon Sep 17 00:00:00 2001 From: TravisBot <> Date: Thu, 21 Sep 2017 23:32:46 +0000 Subject: Rebuilding documentation --- classrapidxml_1_1xml__base.html | 674 ---------------------------------------- 1 file changed, 674 deletions(-) delete mode 100644 classrapidxml_1_1xml__base.html (limited to 'classrapidxml_1_1xml__base.html') diff --git a/classrapidxml_1_1xml__base.html b/classrapidxml_1_1xml__base.html deleted file mode 100644 index e55f430f..00000000 --- a/classrapidxml_1_1xml__base.html +++ /dev/null @@ -1,674 +0,0 @@ - - - - - - - -YAGE: rapidxml::xml_base< Ch > Class Template Reference - - - - - - - - - - - - - - -
-
- - - - - - -
-
YAGE -  v0.1.1 -
-
Yet Another Game Engine
-
-
- - - - - - - -
-
- -
-
-
- -
- -
-
- - -
- -
- -
-
-Public Member Functions | -Static Protected Member Functions | -Protected Attributes | -List of all members
-
-
rapidxml::xml_base< Ch > Class Template Reference
-
-
- -

Base class for xml_node and xml_attribute implementing common functions: name(), name_size(), value(), value_size() and parent(). - More...

- -

#include <rapidxml.h>

-
-Inheritance diagram for rapidxml::xml_base< Ch >:
-
-
- - -rapidxml::xml_attribute< Ch > -rapidxml::xml_node< Ch > -rapidxml::xml_document< Ch > - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

-Public Member Functions

 xml_base ()
 
Ch * name () const
 Gets name of the node. Interpretation of name depends on type of node. Note that name will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.
-
- Use name_size() function to determine length of the name. More...
 
std::size_t name_size () const
 Gets size of node name, not including terminator character. This function works correctly irrespective of whether name is or is not zero terminated. More...
 
Ch * value () const
 Gets value of node. Interpretation of value depends on type of node. Note that value will not be zero-terminated if rapidxml::parse_no_string_terminators option was selected during parse.
-
- Use value_size() function to determine length of the value. More...
 
std::size_t value_size () const
 Gets size of node value, not including terminator character. This function works correctly irrespective of whether value is or is not zero terminated. More...
 
void name (const Ch *name, std::size_t size)
 Sets name of node to a non zero-terminated string. See ownership_of_strings.
-
- Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string will be automatically freed.
-
- Size of name must be specified separately, because name does not have to be zero terminated. Use name(const Ch *) function to have the length automatically calculated (string must be zero terminated). More...
 
void name (const Ch *name)
 Sets name of node to a zero-terminated string. See also ownership_of_strings and xml_node::name(const Ch *, std::size_t). More...
 
void value (const Ch *value, std::size_t size)
 Sets value of node to a non zero-terminated string. See ownership_of_strings.
-
- Note that node does not own its name or value, it only stores a pointer to it. It will not delete or otherwise free the pointer on destruction. It is reponsibility of the user to properly manage lifetime of the string. The easiest way to achieve it is to use memory_pool of the document to allocate the string - on destruction of the document the string will be automatically freed.
-
- Size of value must be specified separately, because it does not have to be zero terminated. Use value(const Ch *) function to have the length automatically calculated (string must be zero terminated).
-
- If an element has a child node of type node_data, it will take precedence over element value when printing. If you want to manipulate data of elements using values, use parser flag rapidxml::parse_no_data_nodes to prevent creation of data nodes by the parser. More...
 
void value (const Ch *value)
 Sets value of node to a zero-terminated string. See also ownership_of_strings and xml_node::value(const Ch *, std::size_t). More...
 
xml_node< Ch > * parent () const
 Gets node parent. More...
 
- - - -

-Static Protected Member Functions

static Ch * nullstr ()
 
- - - - - - - - - - - -

-Protected Attributes

Ch * m_name
 
Ch * m_value
 
std::size_t m_name_size
 
std::size_t m_value_size
 
xml_node< Ch > * m_parent
 
-

Detailed Description

-

template<class Ch = char>
-class rapidxml::xml_base< Ch >

- -
Parameters
- - -
ChCharacter type to use
-
-
-

Constructor & Destructor Documentation

- -

◆ xml_base()

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - - - - -
rapidxml::xml_base< Ch >::xml_base ()
- 		-inline
-
- -
-
-

Member Function Documentation

- -

◆ name() [1/3]

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - - - - -
Ch* rapidxml::xml_base< Ch >::name () const
- 		-inline
-
-
Returns
Name of node, or empty string if node has no name.
- -
-
- -

◆ name() [2/3]

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - - - - - - - - - - - - - - - -
void rapidxml::xml_base< Ch >::name (const Ch * name,
std::size_t size 
)
- 		-inline
-
-
Parameters
- - - -
nameName of node to set. Does not have to be zero terminated.
sizeSize of name, in characters. This does not include zero terminator, if one is present.
-
-
- -
-
- -

◆ name() [3/3]

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - - - - - -
void rapidxml::xml_base< Ch >::name (const Ch * name)
- 		-inline
-
-
Parameters
- - -
nameName of node to set. Must be zero terminated.
-
-
- -
-
- -

◆ name_size()

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - - - - -
std::size_t rapidxml::xml_base< Ch >::name_size () const
- 		-inline
-
-
Returns
Size of node name, in characters.
- -
-
- -

◆ nullstr()

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - - - - -
static Ch* rapidxml::xml_base< Ch >::nullstr ()
- 		-inlinestaticprotected
-
- -
-
- -

◆ parent()

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - - - - -
xml_node<Ch>* rapidxml::xml_base< Ch >::parent () const
- 		-inline
-
-
Returns
Pointer to parent node, or 0 if there is no parent.
- -
-
- -

◆ value() [1/3]

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - - - - -
Ch* rapidxml::xml_base< Ch >::value () const
- 		-inline
-
-
Returns
Value of node, or empty string if node has no value.
- -
-
- -

◆ value() [2/3]

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - - - - - - - - - - - - - - - -
void rapidxml::xml_base< Ch >::value (const Ch * value,
std::size_t size 
)
- 		-inline
-
-
Parameters
- - - -
valuevalue of node to set. Does not have to be zero terminated.
sizeSize of value, in characters. This does not include zero terminator, if one is present.
-
-
- -
-
- -

◆ value() [3/3]

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - - - - - -
void rapidxml::xml_base< Ch >::value (const Ch * value)
- 		-inline
-
-
Parameters
- - -
valueVame of node to set. Must be zero terminated.
-
-
- -
-
- -

◆ value_size()

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - - - - -
std::size_t rapidxml::xml_base< Ch >::value_size () const
- 		-inline
-
-
Returns
Size of node value, in characters.
- -
-
-

Member Data Documentation

- -

◆ m_name

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - -
Ch* rapidxml::xml_base< Ch >::m_name
- 		-protected
-
- -
-
- -

◆ m_name_size

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - -
std::size_t rapidxml::xml_base< Ch >::m_name_size
- 		-protected
-
- -
-
- -

◆ m_parent

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - -
xml_node<Ch>* rapidxml::xml_base< Ch >::m_parent
- 		-protected
-
- -
-
- -

◆ m_value

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - -
Ch* rapidxml::xml_base< Ch >::m_value
- 		-protected
-
- -
-
- -

◆ m_value_size

- -
-
-
-template<class Ch = char>
- - - - - -
- - - - -
std::size_t rapidxml::xml_base< Ch >::m_value_size
- 		-protected
-
- -
-
-
The documentation for this class was generated from the following file: -
-
- - - - -- cgit