@@ -21,12 +21,12 @@ @class OFMutableString; @class OFMutableArray; @class OFMutableDictionary; @class OFXMLAttribute; -/** - * \brief A class which stores an XML element. +/*! + * @brief A class which stores an XML element. */ @interface OFXMLElement: OFXMLNode { OFString *name; OFString *ns; @@ -42,369 +42,369 @@ @property (copy) OFString *defaultNamespace; @property (readonly, copy) OFArray *attributes; @property (readonly, copy) OFArray *children; #endif -/** - * \brief Creates a new XML element with the specified name. +/*! + * @brief Creates a new XML element with the specified name. * - * \param name The name for the element - * \return A new autoreleased OFXMLElement with the specified element name + * @param name The name for the element + * @return A new autoreleased OFXMLElement with the specified element name */ + (instancetype)elementWithName: (OFString*)name; -/** - * \brief Creates a new XML element with the specified name and string value. +/*! + * @brief Creates a new XML element with the specified name and string value. * - * \param name The name for the element - * \param stringValue The value for the element - * \return A new autoreleased OFXMLElement with the specified element name and + * @param name The name for the element + * @param stringValue The value for the element + * @return A new autoreleased OFXMLElement with the specified element name and * value */ + (instancetype)elementWithName: (OFString*)name stringValue: (OFString*)stringValue; -/** - * \brief Creates a new XML element with the specified name and namespace. +/*! + * @brief Creates a new XML element with the specified name and namespace. * - * \param name The name for the element - * \param ns The namespace for the element - * \return A new autoreleased OFXMLElement with the specified element name and + * @param name The name for the element + * @param ns The namespace for the element + * @return A new autoreleased OFXMLElement with the specified element name and * namespace */ + (instancetype)elementWithName: (OFString*)name namespace: (OFString*)ns; -/** - * \brief Creates a new XML element with the specified name, namespace and +/*! + * @brief Creates a new XML element with the specified name, namespace and * string value. * - * \param name The name for the element - * \param ns The namespace for the element - * \param stringValue The value for the element - * \return A new autoreleased OFXMLElement with the specified element name, + * @param name The name for the element + * @param ns The namespace for the element + * @param stringValue The value for the element + * @return A new autoreleased OFXMLElement with the specified element name, * namespace and value */ + (instancetype)elementWithName: (OFString*)name namespace: (OFString*)ns stringValue: (OFString*)stringValue; -/** - * \brief Creates a new element with the specified element. +/*! + * @brief Creates a new element with the specified element. * - * \param element An OFXMLElement to initialize the OFXMLElement with - * \return A new autoreleased OFXMLElement with the contents of the specified + * @param element An OFXMLElement to initialize the OFXMLElement with + * @return A new autoreleased OFXMLElement with the contents of the specified * element */ + (instancetype)elementWithElement: (OFXMLElement*)element; -/** - * \brief Parses the string and returns an OFXMLElement for it. +/*! + * @brief Parses the string and returns an OFXMLElement for it. * - * \param string The string to parse - * \return A new autoreleased OFXMLElement with the contents of the string + * @param string The string to parse + * @return A new autoreleased OFXMLElement with the contents of the string */ + (instancetype)elementWithXMLString: (OFString*)string; -/** - * \brief Parses the specified file and returns an OFXMLElement for it. +/*! + * @brief Parses the specified file and returns an OFXMLElement for it. * - * \param path The path to the file - * \return A new autoreleased OFXMLElement with the contents of the specified + * @param path The path to the file + * @return A new autoreleased OFXMLElement with the contents of the specified * file */ + (instancetype)elementWithFile: (OFString*)path; -/** - * \brief Initializes an already allocated OFXMLElement with the specified name. +/*! + * @brief Initializes an already allocated OFXMLElement with the specified name. * - * \param name The name for the element - * \return An initialized OFXMLElement with the specified element name + * @param name The name for the element + * @return An initialized OFXMLElement with the specified element name */ - initWithName: (OFString*)name; -/** - * \brief Initializes an already allocated OFXMLElement with the specified name +/*! + * @brief Initializes an already allocated OFXMLElement with the specified name * and string value. * - * \param name The name for the element - * \param stringValue The value for the element - * \return An initialized OFXMLElement with the specified element name and + * @param name The name for the element + * @param stringValue The value for the element + * @return An initialized OFXMLElement with the specified element name and * value */ - initWithName: (OFString*)name stringValue: (OFString*)stringValue; -/** - * \brief Initializes an already allocated OFXMLElement with the specified name +/*! + * @brief Initializes an already allocated OFXMLElement with the specified name * and namespace. * - * \param name The name for the element - * \param ns The namespace for the element - * \return An initialized OFXMLElement with the specified element name and + * @param name The name for the element + * @param ns The namespace for the element + * @return An initialized OFXMLElement with the specified element name and * namespace */ - initWithName: (OFString*)name namespace: (OFString*)ns; -/** - * \brief Initializes an already allocated OFXMLElement with the specified name, +/*! + * @brief Initializes an already allocated OFXMLElement with the specified name, * namespace and value. * - * \param name The name for the element - * \param ns The namespace for the element - * \param stringValue The value for the element - * \return An initialized OFXMLElement with the specified element name, + * @param name The name for the element + * @param ns The namespace for the element + * @param stringValue The value for the element + * @return An initialized OFXMLElement with the specified element name, * namespace and value */ - initWithName: (OFString*)name namespace: (OFString*)ns stringValue: (OFString*)stringValue; -/** - * \brief Initializes an already allocated OFXMLElement with the specified - * element. - * - * \param element An OFXMLElement to initialize the OFXMLElement with - * \return A new autoreleased OFXMLElement with the contents of the specified - * element - */ -- initWithElement: (OFXMLElement*)element; - -/** - * \brief Parses the string and initializes an already allocated OFXMLElement - * with it. - * - * \param string The string to parse - * \return An initialized OFXMLElement with the contents of the string - */ -- initWithXMLString: (OFString*)string; - -/** - * \brief Parses the specified file and initializes an already allocated - * OFXMLElement with it. - * - * \param path The path to the file - * \return An initialized OFXMLElement with the contents of the specified file - */ -- initWithFile: (OFString*)path; - -/** - * \brief Sets the name of the element. - * - * \param name The new name - */ -- (void)setName: (OFString*)name; - -/** - * \brief Returns the name of the element. - * - * \return The name of the element - */ -- (OFString*)name; - -/** - * \brief Sets the namespace of the element. - * - * \param ns The new namespace - */ -- (void)setNamespace: (OFString*)ns; - -/** - * \brief Returns the namespace of the element. - * - * \return The namespace of the element - */ -- (OFString*)namespace; - -/** - * \brief Returns an OFArray with the attributes of the element. - * - * \return An OFArray with the attributes of the element - */ -- (OFArray*)attributes; - -/** - * \brief Removes all children and adds the children from the specified array. - * - * \param children The new children to add - */ -- (void)setChildren: (OFArray*)children; - -/** - * \brief Returns an array of OFXMLNodes with all children of the element. - * - * \return An array of OFXMLNodes with all children of the element - */ -- (OFArray*)children; - -/** - * \brief Removes all children and sets the string value to the specified - * string. - * - * \param stringValue The new string value for the element - */ -- (void)setStringValue: (OFString*)stringValue; - -/** - * \brief Adds the specified attribute. - * - * If an attribute with the same name and namespace already exists, it is not - * added. - * - * \param attribute The attribute to add - */ -- (void)addAttribute: (OFXMLAttribute*)attribute; - -/** - * \brief Adds the specified attribute with the specified string value. - * - * If an attribute with the same name and namespace already exists, it is not - * added. - * - * \param name The name of the attribute - * \param stringValue The value of the attribute - */ -- (void)addAttributeWithName: (OFString*)name - stringValue: (OFString*)stringValue; - -/** - * \brief Adds the specified attribute with the specified namespace and string +/*! + * @brief Initializes an already allocated OFXMLElement with the specified + * element. + * + * @param element An OFXMLElement to initialize the OFXMLElement with + * @return A new autoreleased OFXMLElement with the contents of the specified + * element + */ +- initWithElement: (OFXMLElement*)element; + +/*! + * @brief Parses the string and initializes an already allocated OFXMLElement + * with it. + * + * @param string The string to parse + * @return An initialized OFXMLElement with the contents of the string + */ +- initWithXMLString: (OFString*)string; + +/*! + * @brief Parses the specified file and initializes an already allocated + * OFXMLElement with it. + * + * @param path The path to the file + * @return An initialized OFXMLElement with the contents of the specified file + */ +- initWithFile: (OFString*)path; + +/*! + * @brief Sets the name of the element. + * + * @param name The new name + */ +- (void)setName: (OFString*)name; + +/*! + * @brief Returns the name of the element. + * + * @return The name of the element + */ +- (OFString*)name; + +/*! + * @brief Sets the namespace of the element. + * + * @param ns The new namespace + */ +- (void)setNamespace: (OFString*)ns; + +/*! + * @brief Returns the namespace of the element. + * + * @return The namespace of the element + */ +- (OFString*)namespace; + +/*! + * @brief Returns an OFArray with the attributes of the element. + * + * @return An OFArray with the attributes of the element + */ +- (OFArray*)attributes; + +/*! + * @brief Removes all children and adds the children from the specified array. + * + * @param children The new children to add + */ +- (void)setChildren: (OFArray*)children; + +/*! + * @brief Returns an array of OFXMLNodes with all children of the element. + * + * @return An array of OFXMLNodes with all children of the element + */ +- (OFArray*)children; + +/*! + * @brief Removes all children and sets the string value to the specified + * string. + * + * @param stringValue The new string value for the element + */ +- (void)setStringValue: (OFString*)stringValue; + +/*! + * @brief Adds the specified attribute. + * + * If an attribute with the same name and namespace already exists, it is not + * added. + * + * @param attribute The attribute to add + */ +- (void)addAttribute: (OFXMLAttribute*)attribute; + +/*! + * @brief Adds the specified attribute with the specified string value. + * + * If an attribute with the same name and namespace already exists, it is not + * added. + * + * @param name The name of the attribute + * @param stringValue The value of the attribute + */ +- (void)addAttributeWithName: (OFString*)name + stringValue: (OFString*)stringValue; + +/*! + * @brief Adds the specified attribute with the specified namespace and string * value. * * If an attribute with the same name and namespace already exists, it is not * added. * - * \param name The name of the attribute - * \param ns The namespace of the attribute - * \param stringValue The value of the attribute + * @param name The name of the attribute + * @param ns The namespace of the attribute + * @param stringValue The value of the attribute */ - (void)addAttributeWithName: (OFString*)name namespace: (OFString*)ns stringValue: (OFString*)stringValue; -/** - * \brief Returns the attribute with the specified name. +/*! + * @brief Returns the attribute with the specified name. * - * \param attributeName The name of the attribute - * \return The attribute with the specified name + * @param attributeName The name of the attribute + * @return The attribute with the specified name */ - (OFXMLAttribute*)attributeForName: (OFString*)attributeName; -/** - * \brief Returns the attribute with the specified name and namespace. +/*! + * @brief Returns the attribute with the specified name and namespace. * - * \param attributeName The name of the attribute - * \param attributeNS The namespace of the attribute - * \return The attribute with the specified name and namespace + * @param attributeName The name of the attribute + * @param attributeNS The namespace of the attribute + * @return The attribute with the specified name and namespace */ - (OFXMLAttribute*)attributeForName: (OFString*)attributeName namespace: (OFString*)attributeNS; -/** - * \brief Removes the attribute with the specified name. +/*! + * @brief Removes the attribute with the specified name. * - * \param attribteName The name of the attribute + * @param attribteName The name of the attribute */ - (void)removeAttributeForName: (OFString*)attributeName; -/** - * \brief Removes the attribute with the specified name and namespace. +/*! + * @brief Removes the attribute with the specified name and namespace. * - * \param attributeName The name of the attribute - * \param attributeNS The namespace of the attribute + * @param attributeName The name of the attribute + * @param attributeNS The namespace of the attribute */ - (void)removeAttributeForName: (OFString*)attributeName namespace: (OFString*)attributeNS; -/** - * \brief Sets a prefix for a namespace. +/*! + * @brief Sets a prefix for a namespace. * - * \param prefix The prefix for the namespace - * \param ns The namespace for which the prefix is set + * @param prefix The prefix for the namespace + * @param ns The namespace for which the prefix is set */ - (void)setPrefix: (OFString*)prefix forNamespace: (OFString*)ns; -/** - * \brief Binds a prefix for a namespace. +/*! + * @brief Binds a prefix for a namespace. * - * \param prefix The prefix for the namespace - * \param ns The namespace for which the prefix is bound + * @param prefix The prefix for the namespace + * @param ns The namespace for which the prefix is bound */ - (void)bindPrefix: (OFString*)prefix forNamespace: (OFString*)ns; -/** - * \brief Sets the default namespace for the element to be used if there is no +/*! + * @brief Sets the default namespace for the element to be used if there is no * parent. * - * \param ns The default namespace for the element + * @param ns The default namespace for the element */ - (void)setDefaultNamespace: (OFString*)ns; -/** - * \brief Adds a child to the OFXMLElement. +/*! + * @brief Adds a child to the OFXMLElement. * - * \param child An OFXMLNode which is added as a child + * @param child An OFXMLNode which is added as a child */ - (void)addChild: (OFXMLNode*)child; -/** - * \brief Removes the first child that is equal to the specified OFXMLElement. +/*! + * @brief Removes the first child that is equal to the specified OFXMLElement. * - * \param child The child to remove from the OFXMLElement + * @param child The child to remove from the OFXMLElement */ - (void)removeChild: (OFXMLNode*)child; -/** - * \brief Returns all children that are elements. +/*! + * @brief Returns all children that are elements. * - * \return All children that are elements + * @return All children that are elements */ - (OFArray*)elements; -/** - * \brief Returns all children that have the specified namespace. +/*! + * @brief Returns all children that have the specified namespace. * - * \return All children that have the specified namespace + * @return All children that have the specified namespace */ - (OFArray*)elementsForNamespace: (OFString*)elementNS; -/** - * \brief Returns the first child element with the specified name. +/*! + * @brief Returns the first child element with the specified name. * - * \param elementName The name of the element - * \return The first child element with the specified name + * @param elementName The name of the element + * @return The first child element with the specified name */ - (OFXMLElement*)elementForName: (OFString*)elementName; -/** - * \brief Returns the child elements with the specified name. +/*! + * @brief Returns the child elements with the specified name. * - * \param elementName The name of the elements - * \return The child elements with the specified name + * @param elementName The name of the elements + * @return The child elements with the specified name */ - (OFArray*)elementsForName: (OFString*)elementName; -/** - * \brief Returns the first child element with the specified name and namespace. +/*! + * @brief Returns the first child element with the specified name and namespace. * - * \param elementName The name of the element - * \param elementNS The namespace of the element - * \return The first child element with the specified name and namespace + * @param elementName The name of the element + * @param elementNS The namespace of the element + * @return The first child element with the specified name and namespace */ - (OFXMLElement*)elementForName: (OFString*)elementName namespace: (OFString*)elementNS; -/** - * \brief Returns the child elements with the specified name and namespace. +/*! + * @brief Returns the child elements with the specified name and namespace. * - * \param elementName The name of the elements - * \param elementNS The namespace of the elements - * \return The child elements with the specified name and namespace + * @param elementName The name of the elements + * @param elementNS The namespace of the elements + * @return The child elements with the specified name and namespace */ - (OFArray*)elementsForName: (OFString*)elementName namespace: (OFString*)elementNS; @end #import "OFXMLElement+Serialization.h"