From ffc4c126f5416b04a01653e7a03451797b98aba4 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 7 Dec 2021 17:19:15 +1100 Subject: Cleanup: move public doc-strings into headers for 'blenkernel' - Added space below non doc-string comments to make it clear these aren't comments for the symbols directly below them. - Use doxy sections for some headers. - Minor improvements to doc-strings. Ref T92709 --- source/blender/blenkernel/intern/idtype.c | 71 ------------------------------- 1 file changed, 71 deletions(-) (limited to 'source/blender/blenkernel/intern/idtype.c') diff --git a/source/blender/blenkernel/intern/idtype.c b/source/blender/blenkernel/intern/idtype.c index d9dc68b1a4f..e6fd6c14d42 100644 --- a/source/blender/blenkernel/intern/idtype.c +++ b/source/blender/blenkernel/intern/idtype.c @@ -158,13 +158,6 @@ static const IDTypeInfo *idtype_get_info_from_name(const char *idtype_name) /* Various helpers/wrappers around #IDTypeInfo structure. */ -/** - * Convert an \a idcode into a name. - * - * \param idcode: The code to convert. - * \return A static string representing the name of - * the code. - */ const char *BKE_idtype_idcode_to_name(const short idcode) { const IDTypeInfo *id_type = BKE_idtype_get_info_from_idcode(idcode); @@ -172,13 +165,6 @@ const char *BKE_idtype_idcode_to_name(const short idcode) return id_type != NULL ? id_type->name : NULL; } -/** - * Convert an \a idcode into a name (plural). - * - * \param idcode: The code to convert. - * \return A static string representing the name of - * the code. - */ const char *BKE_idtype_idcode_to_name_plural(const short idcode) { const IDTypeInfo *id_type = BKE_idtype_get_info_from_idcode(idcode); @@ -186,12 +172,6 @@ const char *BKE_idtype_idcode_to_name_plural(const short idcode) return id_type != NULL ? id_type->name_plural : NULL; } -/** - * Convert an \a idcode into its translations' context. - * - * \param idcode: The code to convert. - * \return A static string representing the i18n context of the code. - */ const char *BKE_idtype_idcode_to_translation_context(const short idcode) { const IDTypeInfo *id_type = BKE_idtype_get_info_from_idcode(idcode); @@ -199,12 +179,6 @@ const char *BKE_idtype_idcode_to_translation_context(const short idcode) return id_type != NULL ? id_type->translation_context : BLT_I18NCONTEXT_DEFAULT; } -/** - * Convert an ID-type name into an \a idcode (ie. #ID_SCE) - * - * \param idtype_name: The ID-type's "user visible name" to convert. - * \return The \a idcode for the name, or 0 if invalid. - */ short BKE_idtype_idcode_from_name(const char *idtype_name) { const IDTypeInfo *id_type = idtype_get_info_from_name(idtype_name); @@ -212,23 +186,11 @@ short BKE_idtype_idcode_from_name(const char *idtype_name) return id_type != NULL ? id_type->id_code : 0; } -/** - * Return if the ID code is a valid ID code. - * - * \param idcode: The code to check. - * \return Boolean, 0 when invalid. - */ bool BKE_idtype_idcode_is_valid(const short idcode) { return BKE_idtype_get_info_from_idcode(idcode) != NULL ? true : false; } -/** - * Check if an ID type is linkable. - * - * \param idcode: The IDType code to check. - * \return Boolean, false when non linkable, true otherwise. - */ bool BKE_idtype_idcode_is_linkable(const short idcode) { const IDTypeInfo *id_type = BKE_idtype_get_info_from_idcode(idcode); @@ -236,12 +198,6 @@ bool BKE_idtype_idcode_is_linkable(const short idcode) return id_type != NULL ? (id_type->flags & IDTYPE_FLAGS_NO_LIBLINKING) == 0 : false; } -/** - * Check if an ID type is only appendable. - * - * \param idcode: The IDType code to check. - * \return Boolean, false when also linkable, true when only appendable. - */ bool BKE_idtype_idcode_is_only_appendable(const short idcode) { const IDTypeInfo *id_type = BKE_idtype_get_info_from_idcode(idcode); @@ -254,12 +210,6 @@ bool BKE_idtype_idcode_is_only_appendable(const short idcode) return false; } -/** - * Check if an ID type can try to reuse and existing matching local one when being appended again. - * - * \param idcode: The IDType code to check. - * \return Boolean, false when it cannot be re-used, true otherwise. - */ bool BKE_idtype_idcode_append_is_reusable(const short idcode) { const IDTypeInfo *id_type = BKE_idtype_get_info_from_idcode(idcode); @@ -272,9 +222,6 @@ bool BKE_idtype_idcode_append_is_reusable(const short idcode) return false; } -/** - * Convert an \a idcode into an \a idfilter (e.g. ID_OB -> FILTER_ID_OB). - */ uint64_t BKE_idtype_idcode_to_idfilter(const short idcode) { #define CASE_IDFILTER(_id) \ @@ -324,9 +271,6 @@ uint64_t BKE_idtype_idcode_to_idfilter(const short idcode) #undef CASE_IDFILTER } -/** - * Convert an \a idfilter into an \a idcode (e.g. #FILTER_ID_OB -> #ID_OB). - */ short BKE_idtype_idcode_from_idfilter(const uint64_t idfilter) { #define CASE_IDFILTER(_id) \ @@ -375,9 +319,6 @@ short BKE_idtype_idcode_from_idfilter(const uint64_t idfilter) #undef CASE_IDFILTER } -/** - * Convert an \a idcode into an index (e.g. #ID_OB -> #INDEX_ID_OB). - */ int BKE_idtype_idcode_to_index(const short idcode) { #define CASE_IDINDEX(_id) \ @@ -437,9 +378,6 @@ int BKE_idtype_idcode_to_index(const short idcode) #undef CASE_IDINDEX } -/** - * Get an \a idcode from an index (e.g. #INDEX_ID_OB -> #ID_OB). - */ short BKE_idtype_idcode_from_index(const int index) { #define CASE_IDCODE(_id) \ @@ -499,20 +437,11 @@ short BKE_idtype_idcode_from_index(const int index) #undef CASE_IDCODE } -/** - * Return an ID code and steps the index forward 1. - * - * \param index: start as 0. - * \return the code, 0 when all codes have been returned. - */ short BKE_idtype_idcode_iter_step(int *index) { return (*index < ARRAY_SIZE(id_types)) ? BKE_idtype_idcode_from_index((*index)++) : 0; } -/** - * Wrapper around #IDTypeInfo foreach_cache that also handles embedded IDs. - */ void BKE_idtype_id_foreach_cache(struct ID *id, IDTypeForeachCacheFunctionCallback function_callback, void *user_data) -- cgit v1.2.3