@@ -33,14 +33,16 @@ * \brief A protocol that needs to be implemented by delegates for * -[stringByXMLUnescapingWithHandler:]. */ @protocol OFStringXMLUnescapingDelegate /** - * This callback is called when an unknown entity was found while trying to - * unescape XML. The callback is supposed to return a substitution for the - * entity or nil if it is unknown to the callback as well, in which case an - * exception will be thrown. + * \brief This callback is called when an unknown entity was found while trying + * to unescape XML. + * + * The callback is supposed to return a substitution for the entity or nil if + * it is unknown to the callback as well, in which case an exception will be + * thrown. * * \param str The string which contains the unknown entity * \param entity The name of the entity that is unknown * \return A substitution for the entity or nil */ @@ -51,29 +53,29 @@ /** * \brief A category for unescaping XML in strings. */ @interface OFString (XMLUnescaping) /** - * Unescapes XML in the string. + * \brief Unescapes XML in the string. */ - (OFString*)stringByXMLUnescaping; /** - * Unescapes XML in the string and uses the specified delegate for unknown - * entities. + * \brief Unescapes XML in the string and uses the specified delegate for + * unknown entities. * * \param delegate An OFXMLUnescapingDelegate as a handler for unknown entities */ - (OFString*)stringByXMLUnescapingWithDelegate: (id )delegate; #ifdef OF_HAVE_BLOCKS /** - * Unescapes XML in the string and uses the specified block for unknown - * entities. + * \brief Unescapes XML in the string and uses the specified block for unknown + * entities. * * \param block A block which handles unknown entities */ - (OFString*)stringByXMLUnescapingWithBlock: (of_string_xml_unescaping_block_t)block; #endif @end