summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2015-09-01 13:51:33 +0100
committerVincent Sanders <vince@kyllikki.org>2015-09-01 13:51:33 +0100
commit0338d09eea66ede52ee364b8ca05986054bd077c (patch)
tree0fe98450a9f9aebd31b11a6abb74dbc055b1edd2 /src
parentd8a43372a5c9b3e40b55b21bf6a07dfcfc6e61a6 (diff)
downloadlibdom-0338d09eea66ede52ee364b8ca05986054bd077c.tar.gz
libdom-0338d09eea66ede52ee364b8ca05986054bd077c.tar.bz2
Fix some doxygen warnings
Diffstat (limited to 'src')
-rw-r--r--src/core/attr.c6
-rw-r--r--src/core/cdatasection.c7
-rw-r--r--src/core/characterdata.c34
-rw-r--r--src/core/document.c78
-rw-r--r--src/html/html_collection.c4
5 files changed, 64 insertions, 65 deletions
diff --git a/src/core/attr.c b/src/core/attr.c
index d9e2b07..e18e2a7 100644
--- a/src/core/attr.c
+++ b/src/core/attr.c
@@ -81,8 +81,8 @@ static struct dom_node_protect_vtable attr_protect_vtable = {
* \return DOM_NO_ERR on success,
* DOM_NO_MEM_ERR on memory exhaustion.
*
- * ::doc and ::name will have their reference counts increased. The
- * caller should make sure that ::name is a valid NCName here.
+ * \p doc and \p name will have their reference counts increased. The
+ * caller should make sure that \p name is a valid NCName here.
*
* The returned attribute will already be referenced.
*/
@@ -172,7 +172,7 @@ void _dom_attr_finalise(dom_attr *attr)
*
* \param attr The attribute to destroy
*
- * The contents of ::attr will be destroyed and ::attr will be freed
+ * The contents of \p attr will be destroyed and \p attr will be freed
*/
void _dom_attr_destroy(struct dom_attr *attr)
{
diff --git a/src/core/cdatasection.c b/src/core/cdatasection.c
index fd10c3a..c6812e3 100644
--- a/src/core/cdatasection.c
+++ b/src/core/cdatasection.c
@@ -31,10 +31,9 @@ static struct dom_node_protect_vtable cdata_section_protect_vtable = {
* \param name The name of the node to create
* \param value The text content of the node
* \param result Pointer to location to receive created node
- * \return DOM_NO_ERR on success,
- * DOM_NO_MEM_ERR on memory exhaustion.
+ * \return DOM_NO_ERR on success or DOM_NO_MEM_ERR on memory exhaustion.
*
- * ::doc, ::name and ::value will have their reference counts increased.
+ * \p doc, \p name and \p value will have their reference counts increased.
*
* The returned node will already be referenced.
*/
@@ -72,7 +71,7 @@ dom_exception _dom_cdata_section_create(dom_document *doc,
*
* \param cdata The cdata section to destroy
*
- * The contents of ::cdata will be destroyed and ::cdata will be freed.
+ * The contents of \p cdata will be destroyed and \p cdata will be freed.
*/
void _dom_cdata_section_destroy(dom_cdata_section *cdata)
{
diff --git a/src/core/characterdata.c b/src/core/characterdata.c
index 94c286e..ea665b3 100644
--- a/src/core/characterdata.c
+++ b/src/core/characterdata.c
@@ -48,14 +48,14 @@ dom_characterdata *_dom_characterdata_create(void)
/**
* Initialise a character data node
*
- * \param node The node to initialise
+ * \param cdata The character data node to initialise
* \param doc The document which owns the node
* \param type The node type required
* \param name The node name, or NULL
* \param value The node value, or NULL
* \return DOM_NO_ERR on success.
*
- * ::doc, ::name and ::value will have their reference counts increased.
+ * \p doc, \p name and \p value will have their reference counts increased.
*/
dom_exception _dom_characterdata_initialise(struct dom_characterdata *cdata,
struct dom_document *doc, dom_node_type type,
@@ -70,7 +70,7 @@ dom_exception _dom_characterdata_initialise(struct dom_characterdata *cdata,
*
* \param cdata The node to finalise
*
- * The contents of ::cdata will be cleaned up. ::cdata will not be freed.
+ * The contents of \p cdata will be cleaned up. \p cdata will not be freed.
*/
void _dom_characterdata_finalise(struct dom_characterdata *cdata)
{
@@ -115,7 +115,7 @@ dom_exception _dom_characterdata_get_data(struct dom_characterdata *cdata,
* \param cdata Node to set the content of
* \param data New value for node
* \return DOM_NO_ERR on success,
- * DOM_NO_MODIFICATION_ALLOWED_ERR if ::cdata is readonly.
+ * DOM_NO_MODIFICATION_ALLOWED_ERR if \p cdata is readonly.
*
* The new content will have its reference count increased, so the caller
* should unref it after the call (as the caller should have already claimed
@@ -180,9 +180,9 @@ dom_exception _dom_characterdata_get_length(struct dom_characterdata *cdata,
* \param count The number of characters to extract
* \param data Pointer to location to receive substring
* \return DOM_NO_ERR on success,
- * DOM_INDEX_SIZE_ERR if ::offset is negative or greater than the
- * number of characters in ::cdata or
- * ::count is negative.
+ * DOM_INDEX_SIZE_ERR if \p offset is negative or greater than the
+ * number of characters in \p cdata or
+ * \p count is negative.
*
* The returned string will have its reference count increased. It is
* the responsibility of the caller to unref the string once it has
@@ -223,7 +223,7 @@ dom_exception _dom_characterdata_substring_data(
* \param cdata The node to append data to
* \param data The data to append
* \return DOM_NO_ERR on success,
- * DOM_NO_MODIFICATION_ALLOWED_ERR if ::cdata is readonly.
+ * DOM_NO_MODIFICATION_ALLOWED_ERR if \p cdata is readonly.
*/
dom_exception _dom_characterdata_append_data(struct dom_characterdata *cdata,
dom_string *data)
@@ -269,10 +269,10 @@ dom_exception _dom_characterdata_append_data(struct dom_characterdata *cdata,
* \param offset The character offset to insert at
* \param data The data to insert
* \return DOM_NO_ERR on success,
- * DOM_INDEX_SIZE_ERR if ::offset is negative or greater
+ * DOM_INDEX_SIZE_ERR if \p offset is negative or greater
* than the number of characters in
- * ::cdata,
- * DOM_NO_MODIFICATION_ALLOWED_ERR if ::cdata is readonly.
+ * \p cdata,
+ * DOM_NO_MODIFICATION_ALLOWED_ERR if \p cdata is readonly.
*/
dom_exception _dom_characterdata_insert_data(struct dom_characterdata *cdata,
uint32_t offset, dom_string *data)
@@ -331,10 +331,10 @@ dom_exception _dom_characterdata_insert_data(struct dom_characterdata *cdata,
* \param offset The character offset to start deletion from
* \param count The number of characters to delete
* \return DOM_NO_ERR on success,
- * DOM_INDEX_SIZE_ERR if ::offset is negative or greater
+ * DOM_INDEX_SIZE_ERR if \p offset is negative or greater
* than the number of characters in
- * ::cdata or ::count is negative,
- * DOM_NO_MODIFICATION_ALLOWED_ERR if ::cdata is readonly.
+ * \p cdata or \p count is negative,
+ * DOM_NO_MODIFICATION_ALLOWED_ERR if \p cdata is readonly.
*/
dom_exception _dom_characterdata_delete_data(struct dom_characterdata *cdata,
uint32_t offset, uint32_t count)
@@ -400,10 +400,10 @@ dom_exception _dom_characterdata_delete_data(struct dom_characterdata *cdata,
* \param count The number of characters to replace
* \param data The replacement data
* \return DOM_NO_ERR on success,
- * DOM_INDEX_SIZE_ERR if ::offset is negative or greater
+ * DOM_INDEX_SIZE_ERR if \p offset is negative or greater
* than the number of characters in
- * ::cdata or ::count is negative,
- * DOM_NO_MODIFICATION_ALLOWED_ERR if ::cdata is readonly.
+ * \p cdata or \p count is negative,
+ * DOM_NO_MODIFICATION_ALLOWED_ERR if \p cdata is readonly.
*/
dom_exception _dom_characterdata_replace_data(struct dom_characterdata *cdata,
uint32_t offset, uint32_t count,
diff --git a/src/core/document.c b/src/core/document.c
index b68a066..3d43d7a 100644
--- a/src/core/document.c
+++ b/src/core/document.c
@@ -407,9 +407,9 @@ dom_exception _dom_document_get_document_element(dom_document *doc,
* \param tag_name The name of the element
* \param result Pointer to location to receive result
* \return DOM_NO_ERR on success,
- * DOM_INVALID_CHARACTER_ERR if ::tag_name is invalid.
+ * DOM_INVALID_CHARACTER_ERR if \p tag_name is invalid.
*
- * ::doc and ::tag_name will have their reference counts increased.
+ * \p doc and \p tag_name will have their reference counts increased.
*
* The returned node will have its reference count increased. It is
* the responsibility of the caller to unref the node once it has
@@ -548,7 +548,7 @@ dom_exception _dom_document_create_cdata_section(dom_document *doc,
* \param data The data for the node
* \param result Pointer to location to receive result
* \return DOM_NO_ERR on success,
- * DOM_INVALID_CHARACTER_ERR if ::target is invalid,
+ * DOM_INVALID_CHARACTER_ERR if \p target is invalid,
* DOM_NOT_SUPPORTED_ERR if this is an HTML document.
*
* The returned node will have its reference count increased. It is
@@ -573,7 +573,7 @@ dom_exception _dom_document_create_processing_instruction(
* \param name The name of the attribute
* \param result Pointer to location to receive result
* \return DOM_NO_ERR on success,
- * DOM_INVALID_CHARACTER_ERR if ::name is invalid.
+ * DOM_INVALID_CHARACTER_ERR if \p name is invalid.
*
* The constructed attribute will always be classified as 'specified'.
*
@@ -597,7 +597,7 @@ dom_exception _dom_document_create_attribute(dom_document *doc,
* \param name The name of the entity to reference
* \param result Pointer to location to receive result
* \return DOM_NO_ERR on success,
- * DOM_INVALID_CHARACTER_ERR if ::name is invalid,
+ * DOM_INVALID_CHARACTER_ERR if \p name is invalid,
* DOM_NOT_SUPPORTED_ERR if this is an HTML document.
*
* The returned node will have its reference count increased. It is
@@ -643,7 +643,7 @@ dom_exception _dom_document_get_elements_by_tag_name(dom_document *doc,
* \param result Pointer to location to receive imported node in this document.
* \return DOM_NO_ERR on success,
* DOM_INVALID_CHARACTER_ERR if any of the names are invalid,
- * DOM_NOT_SUPPORTED_ERR if the type of ::node is unsupported
+ * DOM_NOT_SUPPORTED_ERR if the type of \p node is unsupported
*
* The returned node will have its reference count increased. It is
* the responsibility of the caller to unref the node once it has
@@ -666,20 +666,20 @@ dom_exception _dom_document_import_node(dom_document *doc,
* \param qname The qualified name of the element
* \param result Pointer to location to receive result
* \return DOM_NO_ERR on success,
- * DOM_INVALID_CHARACTER_ERR if ::qname is invalid,
- * DOM_NAMESPACE_ERR if ::qname is malformed, or it has a
- * prefix and ::namespace is NULL, or
- * ::qname has a prefix "xml" and
- * ::namespace is not
+ * DOM_INVALID_CHARACTER_ERR if \p qname is invalid,
+ * DOM_NAMESPACE_ERR if \p qname is malformed, or it has a
+ * prefix and \p namespace is NULL, or
+ * \p qname has a prefix "xml" and
+ * \p namespace is not
* "http://www.w3.org/XML/1998/namespace",
- * or ::qname has a prefix "xmlns" and
- * ::namespace is not
+ * or \p qname has a prefix "xmlns" and
+ * \p namespace is not
* "http://www.w3.org/2000/xmlns", or
- * ::namespace is
+ * \p namespace is
* "http://www.w3.org/2000/xmlns" and
- * ::qname is not (or is not prefixed by)
+ * \p qname is not (or is not prefixed by)
* "xmlns",
- * DOM_NOT_SUPPORTED_ERR if ::doc does not support the "XML"
+ * DOM_NOT_SUPPORTED_ERR if \p doc does not support the "XML"
* feature.
*
* The returned node will have its reference count increased. It is
@@ -731,20 +731,20 @@ dom_exception _dom_document_create_element_ns(dom_document *doc,
* \param qname The qualified name of the attribute
* \param result Pointer to location to receive result
* \return DOM_NO_ERR on success,
- * DOM_INVALID_CHARACTER_ERR if ::qname is invalid,
- * DOM_NAMESPACE_ERR if ::qname is malformed, or it has a
- * prefix and ::namespace is NULL, or
- * ::qname has a prefix "xml" and
- * ::namespace is not
+ * DOM_INVALID_CHARACTER_ERR if \p qname is invalid,
+ * DOM_NAMESPACE_ERR if \p qname is malformed, or it has a
+ * prefix and \p namespace is NULL, or
+ * \p qname has a prefix "xml" and
+ * \p namespace is not
* "http://www.w3.org/XML/1998/namespace",
- * or ::qname has a prefix "xmlns" and
- * ::namespace is not
+ * or \p qname has a prefix "xmlns" and
+ * \p namespace is not
* "http://www.w3.org/2000/xmlns", or
- * ::namespace is
+ * \p namespace is
* "http://www.w3.org/2000/xmlns" and
- * ::qname is not (or is not prefixed by)
+ * \p qname is not (or is not prefixed by)
* "xmlns",
- * DOM_NOT_SUPPORTED_ERR if ::doc does not support the "XML"
+ * DOM_NOT_SUPPORTED_ERR if \p doc does not support the "XML"
* feature.
*
* The returned node will have its reference count increased. It is
@@ -1043,8 +1043,8 @@ dom_exception _dom_document_set_uri(dom_document *doc,
* \param node The node to adopt
* \param result Pointer to location to receive adopted node
* \return DOM_NO_ERR on success,
- * DOM_NO_MODIFICATION_ALLOWED_ERR if ::node is readonly,
- * DOM_NOT_SUPPORTED_ERR if ::node is of type Document or
+ * DOM_NO_MODIFICATION_ALLOWED_ERR if \p node is readonly,
+ * DOM_NOT_SUPPORTED_ERR if \p node is of type Document or
* DocumentType
*
* The returned node will have its reference count increased. It is
@@ -1150,22 +1150,22 @@ dom_exception _dom_document_normalize(dom_document *doc)
* \param qname The new qualified name for the node
* \param result Pointer to location to receive renamed node
* \return DOM_NO_ERR on success,
- * DOM_INVALID_CHARACTER_ERR if ::tag_name is invalid,
- * DOM_WRONG_DOCUMENT_ERR if ::node was created in a different
+ * DOM_INVALID_CHARACTER_ERR if \p tag_name is invalid,
+ * DOM_WRONG_DOCUMENT_ERR if \p node was created in a different
* document
- * DOM_NAMESPACE_ERR if ::qname is malformed, or it has a
- * prefix and ::namespace is NULL, or
- * ::qname has a prefix "xml" and
- * ::namespace is not
+ * DOM_NAMESPACE_ERR if \p qname is malformed, or it has a
+ * prefix and \p namespace is NULL, or
+ * \p qname has a prefix "xml" and
+ * \p namespace is not
* "http://www.w3.org/XML/1998/namespace",
- * or ::qname has a prefix "xmlns" and
- * ::namespace is not
+ * or \p qname has a prefix "xmlns" and
+ * \p namespace is not
* "http://www.w3.org/2000/xmlns", or
- * ::namespace is
+ * \p namespace is
* "http://www.w3.org/2000/xmlns" and
- * ::qname is not (or is not prefixed by)
+ * \p qname is not (or is not prefixed by)
* "xmlns",
- * DOM_NOT_SUPPORTED_ERR if ::doc does not support the "XML"
+ * DOM_NOT_SUPPORTED_ERR if \p doc does not support the "XML"
* feature.
*
* The returned node will have its reference count increased. It is
diff --git a/src/html/html_collection.c b/src/html/html_collection.c
index 90e35a0..cba2b2d 100644
--- a/src/html/html_collection.c
+++ b/src/html/html_collection.c
@@ -285,7 +285,7 @@ dom_exception dom_html_collection_named_item(dom_html_collection *col,
/**
* Claim a reference on this collection
*
- * \pram col The collection object
+ * \param col The collection object
*/
void dom_html_collection_ref(dom_html_collection *col)
{
@@ -298,7 +298,7 @@ void dom_html_collection_ref(dom_html_collection *col)
/**
* Relese a reference on this collection
*
- * \pram col The collection object
+ * \param col The collection object
*/
void dom_html_collection_unref(dom_html_collection *col)
{