diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-02-11 17:21:09 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-02-11 17:51:03 +0300 |
commit | 452df3f392e29f5f44883bb9cd3bc0c4e8a0ee62 (patch) | |
tree | db7bed3094cda4e39c6ce514a7fd14a0c7e94397 /source/blender/blenkernel/intern | |
parent | 36aa8499e80dfcb73ebebb0c365a7a01460fa5a4 (diff) |
Cleanup: comments
Diffstat (limited to 'source/blender/blenkernel/intern')
-rw-r--r-- | source/blender/blenkernel/intern/DerivedMesh.c | 2 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/font.c | 1 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/library_idmap.c | 4 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/library_remap.c | 16 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/main.c | 17 | ||||
-rw-r--r-- | source/blender/blenkernel/intern/mesh_runtime.c | 2 |
6 files changed, 20 insertions, 22 deletions
diff --git a/source/blender/blenkernel/intern/DerivedMesh.c b/source/blender/blenkernel/intern/DerivedMesh.c index a0e85b99c02..d31fb72e4a0 100644 --- a/source/blender/blenkernel/intern/DerivedMesh.c +++ b/source/blender/blenkernel/intern/DerivedMesh.c @@ -460,7 +460,7 @@ void DM_ensure_normals(DerivedMesh *dm) /** * Ensure the array is large enough * - * /note This function must always be thread-protected by caller. It should only be used by internal code. + * \note This function must always be thread-protected by caller. It should only be used by internal code. */ void DM_ensure_looptri_data(DerivedMesh *dm) { diff --git a/source/blender/blenkernel/intern/font.c b/source/blender/blenkernel/intern/font.c index ec8d4c8f75e..a1f9eaa3ac7 100644 --- a/source/blender/blenkernel/intern/font.c +++ b/source/blender/blenkernel/intern/font.c @@ -1261,7 +1261,6 @@ makebreak: sb = &selboxes[i - selstart]; sb->rot = -ct->rot; } - } } } diff --git a/source/blender/blenkernel/intern/library_idmap.c b/source/blender/blenkernel/intern/library_idmap.c index 3ab5cbaeef3..579465ce2fd 100644 --- a/source/blender/blenkernel/intern/library_idmap.c +++ b/source/blender/blenkernel/intern/library_idmap.c @@ -87,8 +87,8 @@ static struct IDNameLib_TypeMap *main_idmap_from_idcode(struct IDNameLib_Map *id * #BKE_main_idmap_lookup_id will then check that given ID does exist in \a old_bmain * before trying to use it. * - * \param create_valid_ids_set If \a true, generate a reference to prevent freed memory accesses. - * \param old_bmain If not NULL, its IDs will be added the the valid references set. + * \param create_valid_ids_set: If \a true, generate a reference to prevent freed memory accesses. + * \param old_bmain: If not NULL, its IDs will be added the valid references set. */ struct IDNameLib_Map *BKE_main_idmap_create( struct Main *bmain, const bool create_valid_ids_set, struct Main *old_bmain) diff --git a/source/blender/blenkernel/intern/library_remap.c b/source/blender/blenkernel/intern/library_remap.c index efd90634741..bbe8756b9c8 100644 --- a/source/blender/blenkernel/intern/library_remap.c +++ b/source/blender/blenkernel/intern/library_remap.c @@ -815,12 +815,12 @@ void BKE_libblock_free_datablock(ID *id, const int UNUSED(flag)) * However, they might still be using (referencing) other IDs, this code takes care of it if * \a LIB_TAG_NO_USER_REFCOUNT is not defined. * - * \param bmain Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main. - * \param idv Pointer to ID to be freed. - * \param flag Set of \a LIB_ID_FREE_... flags controlling/overriding usual freeing process, - * 0 to get default safe behavior. - * \param use_flag_from_idtag Still use freeing info flags from given ID datablock, - * even if some overriding ones are passed in \a falg parameter. + * \param bmain: Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main. + * \param idv: Pointer to ID to be freed. + * \param flag: Set of \a LIB_ID_FREE_... flags controlling/overriding usual freeing process, + * 0 to get default safe behavior. + * \param use_flag_from_idtag: Still use freeing info flags from given ID datablock, + * even if some overriding ones are passed in \a falg parameter. */ void BKE_id_free_ex(Main *bmain, void *idv, int flag, const bool use_flag_from_idtag) { @@ -910,8 +910,8 @@ void BKE_id_free_ex(Main *bmain, void *idv, int flag, const bool use_flag_from_i * * See #BKE_id_free_ex description for full details. * - * \param bmain Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main. - * \param idv Pointer to ID to be freed. + * \param bmain: Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main. + * \param idv: Pointer to ID to be freed. */ void BKE_id_free(Main *bmain, void *idv) { diff --git a/source/blender/blenkernel/intern/main.c b/source/blender/blenkernel/intern/main.c index 37d812adfa2..11150f827e2 100644 --- a/source/blender/blenkernel/intern/main.c +++ b/source/blender/blenkernel/intern/main.c @@ -19,7 +19,7 @@ /** \file \ingroup bke * - * Contains management of Main database itself. + * Contains management of #Main database itself. */ #include <string.h> @@ -219,7 +219,7 @@ static bool main_gset_create(Main *UNUSED(bmain), ID *id, void *user_data) /** * Create a GSet storing all IDs present in given \a bmain, by their pointers. * - * \param gset If not NULL, given GSet will be extended with IDs from given \a bmain, instead of creating a new one. + * \param gset: If not NULL, given GSet will be extended with IDs from given \a bmain, instead of creating a new one. */ GSet *BKE_main_gset_create(Main *bmain, GSet *gset) { @@ -253,10 +253,9 @@ bool BKE_main_listbase_foreach_id( /** * Call given callback over every IDs of given \a bmain Main database. * - * \param reverse_type_order Allow to reverse order in which ID *types* are handled - * (i.e. does not reverse the order in which IDs themselves are handled - * whithin a give listbase). - * Note that in most cases, you want to set that parameter to true. + * \param reverse_type_order: Allow to reverse order in which ID *types* are handled + * (i.e. does not reverse the order in which IDs themselves are handled whithin a give listbase). + * Note that in most cases, you want to set that parameter to true. * \return false if the iteration was iterrupted by the callback. * * \warning \a callback may affect the ID, but DO NOT change the Main database (add/remove/reorder its IDs). @@ -357,7 +356,7 @@ const char *BKE_main_blendfile_path(const Main *bmain) } /** - * Return filepath of global main (G_MAIN). + * Return filepath of global main #G_MAIN. * * \warning Usage is not recommended, you should always try to get a valid Main pointer from context... */ @@ -449,12 +448,12 @@ ListBase *which_libbase(Main *bmain, short type) } /** - * puts into array *lb pointers to all the ListBase structs in main, + * puts into array *lb pointers to all the #ListBase structs in main, * and returns the number of them as the function result. This is useful for * generic traversal of all the blocks in a Main (by traversing all the * lists in turn), without worrying about block types. * - * \note MAX_LIBARRAY define should match this code */ + * \note #MAX_LIBARRAY define should match this code */ int set_listbasepointers(Main *bmain, ListBase **lb) { /* BACKWARDS! also watch order of free-ing! (mesh<->mat), first items freed last. diff --git a/source/blender/blenkernel/intern/mesh_runtime.c b/source/blender/blenkernel/intern/mesh_runtime.c index 2fe6f435367..788558e5378 100644 --- a/source/blender/blenkernel/intern/mesh_runtime.c +++ b/source/blender/blenkernel/intern/mesh_runtime.c @@ -76,7 +76,7 @@ void BKE_mesh_runtime_clear_cache(Mesh *mesh) /** * Ensure the array is large enough * - * /note This function must always be thread-protected by caller. It should only be used by internal code. + * \note This function must always be thread-protected by caller. It should only be used by internal code. */ static void mesh_ensure_looptri_data(Mesh *mesh) { |