From e757c4a3bec8b0e8d198531a28327332af00a9ba Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 12 Dec 2018 12:50:58 +1100 Subject: Cleanup: use colon separator after parameter Helps separate variable names from descriptive text. Was already used in some parts of the code, double space and dashes were used elsewhere. --- source/blender/makesdna/intern/dna_genfile.c | 90 ++++++++++++++-------------- source/blender/makesdna/intern/makesdna.c | 6 +- 2 files changed, 48 insertions(+), 48 deletions(-) (limited to 'source/blender/makesdna/intern') diff --git a/source/blender/makesdna/intern/dna_genfile.c b/source/blender/makesdna/intern/dna_genfile.c index 077bae741b8..cae702da3c3 100644 --- a/source/blender/makesdna/intern/dna_genfile.c +++ b/source/blender/makesdna/intern/dna_genfile.c @@ -193,8 +193,8 @@ static bool ispointer(const char *name) /** * Returns the size of struct fields of the specified type and name. * - * \param type Index into sdna->types/typelens - * \param name Index into sdna->names, + * \param type: Index into sdna->types/typelens + * \param name: Index into sdna->names, * needed to extract possible pointer/array information. */ static int elementsize(const SDNA *sdna, short type, short name) @@ -753,11 +753,11 @@ static eSDNA_Type sdna_type_nr(const char *dna_type) * Note there is no optimization for the case where otype and ctype are the same: * assumption is that caller will handle this case. * - * \param ctype Name of type to convert to - * \param otype Name of type to convert from - * \param name Field name to extract array-size information - * \param curdata Where to put converted data - * \param olddata Data of type otype to convert + * \param ctype: Name of type to convert to + * \param otype: Name of type to convert from + * \param name: Field name to extract array-size information + * \param curdata: Where to put converted data + * \param olddata: Data of type otype to convert */ static void cast_elem( const char *ctype, const char *otype, const char *name, @@ -836,11 +836,11 @@ static void cast_elem( * as lookup keys to identify data blocks in the saved .blend file, not * as actual in-memory pointers. * - * \param curlen Pointer length to conver to - * \param oldlen Length of pointers in olddata - * \param name Field name to extract array-size information - * \param curdata Where to put converted data - * \param olddata Data to convert + * \param curlen: Pointer length to conver to + * \param oldlen: Length of pointers in olddata + * \param name: Field name to extract array-size information + * \param curdata: Where to put converted data + * \param olddata: Data to convert */ static void cast_pointer(int curlen, int oldlen, const char *name, char *curdata, const char *olddata) { @@ -897,10 +897,10 @@ static int elem_strcmp(const char *name, const char *oname) * Returns whether the specified field exists according to the struct format * pointed to by old. * - * \param sdna Old SDNA - * \param type Current field type name - * \param name Current field name - * \param old Pointer to struct information in sdna + * \param sdna: Old SDNA + * \param type: Current field type name + * \param name: Current field name + * \param old: Pointer to struct information in sdna * \return true when existing, false otherwise. */ static bool elem_exists( @@ -935,12 +935,12 @@ static bool elem_exists( * return NULL both when the field is found at offset 0 and when it is not * found at all. For field existence checks, use elem_exists() instead. * - * \param sdna Old SDNA - * \param type Current field type name - * \param name Current field name - * \param old Pointer to struct information in sdna - * \param olddata Struct data - * \param sppo Optional place to return pointer to field info in sdna + * \param sdna: Old SDNA + * \param type: Current field type name + * \param name: Current field name + * \param old: Pointer to struct information in sdna + * \param olddata: Struct data + * \param sppo: Optional place to return pointer to field info in sdna * \return Data address. */ static const char *find_elem( @@ -984,13 +984,13 @@ static const char *find_elem( * Converts the contents of a single field of a struct, of a non-struct type, * from oldsdna to newsdna format. * - * \param newsdna SDNA of current Blender - * \param oldsdna SDNA of Blender that saved file - * \param type current field type name - * \param name current field name - * \param curdata put field data converted to newsdna here - * \param old pointer to struct info in oldsdna - * \param olddata struct contents laid out according to oldsdna + * \param newsdna: SDNA of current Blender + * \param oldsdna: SDNA of Blender that saved file + * \param type: current field type name + * \param name: current field name + * \param curdata: put field data converted to newsdna here + * \param old: pointer to struct info in oldsdna + * \param olddata: struct contents laid out according to oldsdna */ static void reconstruct_elem( const SDNA *newsdna, @@ -1080,15 +1080,15 @@ static void reconstruct_elem( /** * Converts the contents of an entire struct from oldsdna to newsdna format. * - * \param newsdna SDNA of current Blender - * \param oldsdna SDNA of Blender that saved file - * \param compflags + * \param newsdna: SDNA of current Blender + * \param oldsdna: SDNA of Blender that saved file + * \param compflags: * * Result from DNA_struct_get_compareflags to avoid needless conversions. - * \param oldSDNAnr Index of old struct definition in oldsdna - * \param data Struct contents laid out according to oldsdna - * \param curSDNAnr Index of current struct definition in newsdna - * \param cur Where to put converted struct contents + * \param oldSDNAnr: Index of old struct definition in oldsdna + * \param data: Struct contents laid out according to oldsdna + * \param curSDNAnr: Index of current struct definition in newsdna + * \param cur: Where to put converted struct contents */ static void reconstruct_struct( const SDNA *newsdna, @@ -1187,9 +1187,9 @@ static void reconstruct_struct( /** * Does endian swapping on the fields of a struct value. * - * \param oldsdna SDNA of Blender that saved file - * \param oldSDNAnr Index of struct info within oldsdna - * \param data Struct data + * \param oldsdna: SDNA of Blender that saved file + * \param oldSDNAnr: Index of struct info within oldsdna + * \param data: Struct data */ void DNA_struct_switch_endian(const SDNA *oldsdna, int oldSDNAnr, char *data) { @@ -1273,14 +1273,14 @@ void DNA_struct_switch_endian(const SDNA *oldsdna, int oldSDNAnr, char *data) } /** - * \param newsdna SDNA of current Blender - * \param oldsdna SDNA of Blender that saved file - * \param compflags + * \param newsdna: SDNA of current Blender + * \param oldsdna: SDNA of Blender that saved file + * \param compflags: * * Result from DNA_struct_get_compareflags to avoid needless conversions - * \param oldSDNAnr Index of struct info within oldsdna - * \param blocks The number of array elements - * \param data Array of struct data + * \param oldSDNAnr: Index of struct info within oldsdna + * \param blocks: The number of array elements + * \param data: Array of struct data * \return An allocated reconstructed struct */ void *DNA_struct_reconstruct( diff --git a/source/blender/makesdna/intern/makesdna.c b/source/blender/makesdna/intern/makesdna.c index 5d5efda975f..a6262a9b130 100644 --- a/source/blender/makesdna/intern/makesdna.c +++ b/source/blender/makesdna/intern/makesdna.c @@ -166,14 +166,14 @@ static int additional_slen_offset; /** * Add type \c str to struct indexed by \c len, if it was not yet found. - * \param str char - * \param len int + * \param str: char + * \param len: int */ static int add_type(const char *str, int len); /** * Add variable \c str to - * \param str + * \param str: */ static int add_name(const char *str); -- cgit v1.2.3