Cleanup: doxygen comments

Also correct some outdated symbol references,
add missing 'name' commands.

1 files changed, 11 insertions, 7 deletions

diff --git a/source/blender/imbuf/IMB_metadata.h b/source/blender/imbuf/IMB_metadata.h
index 64a8db6c526..fc08e17dd96 100644
--- a/source/blender/imbuf/IMB_metadata.h
+++ b/source/blender/imbuf/IMB_metadata.h
@@ -28,7 +28,8 @@ struct IDProperty;
 struct ImBuf;
 struct anim;
 
-/** The metadata is a list of key/value pairs (both char *) that can me
+/**
+ * The metadata is a list of key/value pairs (both char *) that can me
  * saved in the header of several image formats.
  * Apart from some common keys like
  * 'Software' and 'Description' (png standard) we'll use keys within the
@@ -38,29 +39,32 @@ struct anim;
  * The keys & values are stored in ID properties, in the group "metadata".
  */
 
-/** Ensure that the metadata property is a valid IDProperty object.
+/**
+ * Ensure that the metadata property is a valid #IDProperty object.
  * This is a no-op when *metadata != NULL.
  */
 void IMB_metadata_ensure(struct IDProperty **metadata);
 void IMB_metadata_free(struct IDProperty *metadata);
 
-/** Read the field from the image info into the field.
- * \param metadata: the IDProperty that contains the metadata
+/**
+ * Read the field from the image info into the field.
+ * \param metadata: the #IDProperty that contains the metadata
  * \param key: the key of the field
  * \param value: the data in the field, first one found with key is returned,
  *                 memory has to be allocated by user.
  * \param len: length of value buffer allocated by user.
- * \return    - 1 (true) if metadata is present and value for the key found, 0 (false) otherwise
+ * \return 1 (true) if metadata is present and value for the key found, 0 (false) otherwise.
  */
 bool IMB_metadata_get_field(struct IDProperty *metadata,
                             const char *key,
                             char *value,
                             const size_t len);
 
-/** Set user data in the metadata.
+/**
+ * Set user data in the metadata.
  * If the field already exists its value is overwritten, otherwise the field
  * will be added with the given value.
- * \param metadata: the IDProperty that contains the metadata
+ * \param metadata: the #IDProperty that contains the metadata
  * \param key: the key of the field
  * \param value: the data to be written to the field. zero terminated string
  */