Cleanup: move public doc-strings into headers for 'makesdna'

Ref T92709

1 files changed, 17 insertions, 0 deletions

diff --git a/source/blender/makesdna/intern/dna_utils.h b/source/blender/makesdna/intern/dna_utils.h
index f711056c575..b89c45a7a43 100644
--- a/source/blender/makesdna/intern/dna_utils.h
+++ b/source/blender/makesdna/intern/dna_utils.h
@@ -27,16 +27,30 @@ extern "C" {
 struct GHash;
 struct MemArena;
 
+/**
+ * Parses the `[n1][n2]...` on the end of an array name
+ * and returns the number of array elements `n1 * n2 ...`.
+ */
 int DNA_elem_array_size(const char *str);
 
 uint DNA_elem_id_offset_start(const char *elem_full);
 uint DNA_elem_id_offset_end(const char *elem_full);
+/**
+ * \a elem_dst must be at least the size of \a elem_src.
+ */
 uint DNA_elem_id_strip_copy(char *elem_dst, const char *elem_src);
 uint DNA_elem_id_strip(char *elem);
+/**
+ * Check if 'var' matches '*var[3]' for eg,
+ * return true if it does, with start/end offsets.
+ */
 bool DNA_elem_id_match(const char *elem_search,
                        const int elem_search_len,
                        const char *elem_full,
                        uint *r_elem_full_offset);
+/**
+ * Return a renamed dna name, allocated from \a mem_arena.
+ */
 char *DNA_elem_id_rename(struct MemArena *mem_arena,
                          const char *elem_src,
                          const int elem_src_len,
@@ -56,6 +70,9 @@ void DNA_alias_maps(enum eDNA_RenameDir version_dir,
                     struct GHash **r_elem_map);
 
 const char *DNA_struct_rename_legacy_hack_alias_from_static(const char *name);
+/**
+ * DNA Compatibility Hack.
+ */
 const char *DNA_struct_rename_legacy_hack_static_from_alias(const char *name);
 
 #ifdef __cplusplus