Browse Source

Cleanup: consistent syntax for doxygen parameters

Also use back-slash instead of '@'.
master
Campbell Barton 1 year ago
parent
commit
bedc68a838
  1. 2
      intern/guardedalloc/MEM_guardedalloc.h
  2. 10
      source/blender/blenkernel/intern/collection.c
  3. 24
      source/blender/blenkernel/intern/lib_override.c
  4. 2
      source/blender/blenkernel/intern/unit.c
  5. 2
      source/blender/editors/interface/interface_panel.c
  6. 4
      source/blender/gpu/intern/gpu_texture.cc
  7. 14
      source/blender/gpu/opengl/gl_framebuffer.hh

2
intern/guardedalloc/MEM_guardedalloc.h

@ -165,7 +165,7 @@ extern void (*MEM_set_error_callback)(void (*func)(const char *));
/**
* Are the start/end block markers still correct ?
*
* @retval true for correct memory, false for corrupted memory. */
* \retval true for correct memory, false for corrupted memory. */
extern bool (*MEM_consistency_check)(void);
/** Attempt to enforce OSX (or other OS's) to have malloc and stack nonzero */

10
source/blender/blenkernel/intern/collection.c

@ -1182,10 +1182,10 @@ static bool collection_instance_find_recursive(Collection *collection,
/**
* Find potential cycles in collections.
*
* \param new_ancestor the potential new owner of given \a collection, or the collection to check
* if the later is NULL.
* \param collection the collection we want to add to \a new_ancestor, may be NULL if we just want
* to ensure \a new_ancestor does not already have cycles.
* \param new_ancestor: the potential new owner of given \a collection,
* or the collection to check if the later is NULL.
* \param collection: the collection we want to add to \a new_ancestor,
* may be NULL if we just want to ensure \a new_ancestor does not already have cycles.
* \return true if a cycle is found.
*/
bool BKE_collection_cycle_find(Collection *new_ancestor, Collection *collection)
@ -1254,7 +1254,7 @@ static bool collection_cycle_fix_recursive(Main *bmain,
/**
* Find and fix potential cycles in collections.
*
* \param collection the collection to check for existing cycles.
* \param collection: The collection to check for existing cycles.
* \return true if cycles are found and fixed.
*/
bool BKE_collection_cycles_fix(Main *bmain, Collection *collection)

24
source/blender/blenkernel/intern/lib_override.c

@ -409,9 +409,9 @@ static bool lib_override_hierarchy_recursive_tag(Main *bmain,
*
* This will include all local IDs, and all IDs from the same library as the \a id_root.
*
* \param id_root The root of the hierarchy of dependencies to be tagged.
* \param do_create_main_relashionships Whether main relations needs to be created or already exist
* (in any case, they will be freed by this function).
* \param id_root: The root of the hierarchy of dependencies to be tagged.
* \param do_create_main_relashionships: Whether main relations needs to be created or already
* exist (in any case, they will be freed by this function).
*/
void BKE_lib_override_library_dependencies_tag(Main *bmain,
ID *id_root,
@ -435,9 +435,9 @@ void BKE_lib_override_library_dependencies_tag(Main *bmain,
* That is, all other liboverrides IDs (in)directly used by \a is_root one, sharing the same
* library for their reference IDs.
*
* \param id_root The root of the hierarchy of liboverride dependencies to be tagged.
* \param do_create_main_relashionships Whether main relations needs to be created or already exist
* (in any case, they will be freed by this function).
* \param id_root: The root of the hierarchy of liboverride dependencies to be tagged.
* \param do_create_main_relashionships: Whether main relations needs to be created or already
* exist (in any case, they will be freed by this function).
*/
void BKE_lib_override_library_override_group_tag(Main *bmain,
ID *id_root,
@ -640,10 +640,10 @@ static void lib_override_library_create_post_process(
* \note In the future that same function may be extended to support 'refresh' of overrides
* (rebuilding overrides from linked data, trying to preserve local overrides already defined).
*
* \param id_root The root ID to create an override from.
* \param id_reference some reference ID used to do some post-processing after overrides have been
* created, may be NULL. Typically, the Empty object instantiating the linked
* collection we override, currently.
* \param id_root: The root ID to create an override from.
* \param id_reference: Some reference ID used to do some post-processing after overrides have been
* created, may be NULL. Typically, the Empty object instantiating the linked
* collection we override, currently.
* \return true if override was successfully created.
*/
bool BKE_lib_override_library_create(
@ -668,7 +668,7 @@ bool BKE_lib_override_library_create(
* Advanced 'smart' function to resync, re-create fully functional overrides up-to-date with linked
* data, from an existing override hierarchy.
*
* \param id_root The root liboverride ID to resync from.
* \param id_root: The root liboverride ID to resync from.
* \return true if override was successfully resynced.
*/
bool BKE_lib_override_library_resync(Main *bmain, Scene *scene, ViewLayer *view_layer, ID *id_root)
@ -790,7 +790,7 @@ bool BKE_lib_override_library_resync(Main *bmain, Scene *scene, ViewLayer *view_
*
* \note All IDs tagged with `LIB_TAG_DOIT` will be deleted.
*
* \param id_root The root liboverride ID to resync from.
* \param id_root: The root liboverride ID to resync from.
*/
void BKE_lib_override_library_delete(Main *bmain, ID *id_root)
{

2
source/blender/blenkernel/intern/unit.c

@ -1099,7 +1099,7 @@ double bUnit_ApplyPreferredUnit(const struct UnitSettings *settings, int type, d
* Values will be split by an add sign.
* 5'2" -> 5*0.3048 + 2*0.0254
*
* \param str_prev is optional, when valid it is used to get a base unit when none is set.
* \param str_prev: is optional, when valid it is used to get a base unit when none is set.
*
* \return True of a change was made.
*/

2
source/blender/editors/interface/interface_panel.c

@ -2074,7 +2074,7 @@ static void ui_panel_drag_collapse_handler_add(const bContext *C, const bool was
* Supposing the block has a panel and isn't a menu, handle opening, closing, pinning, etc.
* Code currently assumes layout style for location of widgets
*
* \param mx The mouse x coordinate, in panel space.
* \param mx: The mouse x coordinate, in panel space.
*/
static void ui_handle_panel_header(const bContext *C,
uiBlock *block,

4
source/blender/gpu/intern/gpu_texture.cc

@ -365,8 +365,8 @@ void *GPU_texture_read(GPUTexture *tex_, eGPUDataFormat data_format, int miplvl)
* Fills the whole texture with the same data for all pixels.
* \warning Only work for 2D texture for now.
* \warning Only clears the mip 0 of the texture.
* \param data_format data format of the pixel data.
* \param data 1 pixel worth of data to fill the texture with.
* \param data_format: data format of the pixel data.
* \param data: 1 pixel worth of data to fill the texture with.
*/
void GPU_texture_clear(GPUTexture *tex, eGPUDataFormat data_format, const void *data)
{

14
source/blender/gpu/opengl/gl_framebuffer.hh

@ -63,13 +63,13 @@ class GLFrameBuffer : public FrameBuffer {
GLFrameBuffer(const char *name);
/**
* Special Framebuffer encapsulating internal window framebuffer.
* (i.e.: GL_FRONT_LEFT, GL_BACK_RIGHT, ...)
* @param ctx context the handle is from.
* @param target the internal GL name (i.e: GL_BACK_LEFT).
* @param fbo the (optional) already created object for some implementation. Default is 0.
* @param w buffer width.
* @param h buffer height.
* Special frame-buffer encapsulating internal window frame-buffer.
* (i.e.: #GL_FRONT_LEFT, #GL_BACK_RIGHT, ...)
* \param ctx: context the handle is from.
* \param target: the internal GL name (i.e: #GL_BACK_LEFT).
* \param fbo: the (optional) already created object for some implementation. Default is 0.
* \param w: buffer width.
* \param h: buffer height.
**/
GLFrameBuffer(const char *name, GLContext *ctx, GLenum target, GLuint fbo, int w, int h);

Loading…
Cancel
Save