Cleanup: doxygen syntax, use colons after "param" arguments, not "note"

This commit is contained in:
Campbell Barton
2024-04-24 10:55:44 +10:00
parent 019d3ef939
commit 1865776767
24 changed files with 43 additions and 43 deletions

View File

@@ -123,16 +123,16 @@ class Animation : public ::Animation {
/** Assign this animation to the ID.
*
* \param binding The binding this ID should be animated by, may be nullptr if it is to be
* \param binding: The binding this ID should be animated by, may be nullptr if it is to be
* assigned later. In that case, the ID will not actually receive any animation.
* \param animated_id The ID that should be animated by this Animation data-block.
* \param animated_id: The ID that should be animated by this Animation data-block.
*/
bool assign_id(Binding *binding, ID &animated_id);
/**
* Unassign this Animation from the animated ID.
*
* \param animated_id ID that is animated by this Animation. Calling this
* \param animated_id: ID that is animated by this Animation. Calling this
* function when this ID is _not_ animated by this Animation is not allowed,
* and considered a bug.
*/

View File

@@ -50,7 +50,7 @@ BoneCollection *ANIM_bonecoll_new(const char *name) ATTR_WARN_UNUSED_RESULT;
*
* \see ANIM_armature_bonecoll_remove
*
* \param do_id_user_count whether to update user counts for IDs referenced from IDProperties of
* \param do_id_user_count: Whether to update user counts for IDs referenced from IDProperties of
* the bone collection. Needs to be false when freeing an evaluated copy, true otherwise.
*/
void ANIM_bonecoll_free(BoneCollection *bcoll, bool do_id_user_count = true);

View File

@@ -23,7 +23,7 @@ namespace blender::animrig {
*
* Animate the given ID, using the animation data-block and the given binding.
*
* \param flush_to_original when true, look up the original data-block (assuming
* \param flush_to_original: when true, look up the original data-block (assuming
* the given one is an evaluated copy) and update that too.
*/
void evaluate_and_apply_animation(PointerRNA &animated_id_ptr,

View File

@@ -231,8 +231,8 @@ bool autokeyframe_property(bContext *C,
* expected to be the size of the property array.
* \param frame: is expected to be in the local time of the action, meaning it has to be NLA mapped
* already.
* \param keying_mask is expected to have the same size as `rna_path`. A false bit means that index
* will be skipped.
* \param keying_mask: is expected to have the same size as `rna_path`.
* A false bit means that index will be skipped.
* \returns How often keyframe insertion was successful and how often it failed / for which reason.
*/
CombinedKeyingResult insert_key_action(Main *bmain,

View File

@@ -28,7 +28,7 @@ EvaluationResult blend_layer_results(const EvaluationResult &last_result,
/**
* Apply the result of the animation evaluation to the given data-block.
*
* \param flush_to_original when true, look up the original data-block (assuming the given one is
* \param flush_to_original: when true, look up the original data-block (assuming the given one is
* an evaluated copy) and update that too.
*/
void apply_evaluation_result(const EvaluationResult &evaluation_result,

View File

@@ -100,7 +100,7 @@ AnimData *BKE_animdata_copy(Main *bmain, AnimData *adt, int flag);
/**
* Same as #BKE_animdata_copy, but allows to duplicate Action IDs into a library.
*
* \param owner_library the Library to 'assign' the newly created ID to. Use `nullptr` to make ID
* \param owner_library: the Library to 'assign' the newly created ID to. Use `nullptr` to make ID
* not use any library (i.e. become a local ID). Use `std::nullopt` for default behavior (i.e.
* behavior of the #BKE_animdata_copy function).
*/

View File

@@ -64,7 +64,7 @@ void *BKE_libblock_alloc_notest(short type) ATTR_WARN_UNUSED_RESULT;
* The user count is set to 1, all other content (apart from name and links) being
* initialized to zero.
*
* \note: By default, IDs allocated in a Main database will get the current library of the Main,
* \note By default, IDs allocated in a Main database will get the current library of the Main,
* i.e. usually (besides in readfile case), they will have a `nullptr` `lib` pointer and be local
* data. IDs allocated outside of a Main database will always get a `nullptr` `lib` pointer.
*/
@@ -73,7 +73,7 @@ void *BKE_libblock_alloc(Main *bmain, short type, const char *name, int flag)
/**
* Same as for #BKE_libblock_alloc, but allows creating a data-block for a given owner library.
*
* \param owner_library the Library to 'assign' the newly created ID to. Use `nullptr` to make ID
* \param owner_library: the Library to 'assign' the newly created ID to. Use `nullptr` to make ID
* not use any library (i.e. become a local ID). Use `std::nullopt` for default behavior (i.e.
* behavior of the #BKE_libblock_alloc function).
*/
@@ -120,7 +120,7 @@ void BKE_lib_libblock_session_uid_renew(ID *id);
/**
* Generic helper to create a new empty data-block of given type in given \a bmain database.
*
* \note: By default, IDs created in a Main database will get the current library of the Main,
* \note By default, IDs created in a Main database will get the current library of the Main,
* i.e. usually (besides in readfile case), they will have a `nullptr` `lib` pointer and be local
* data. IDs created outside of a Main database will always get a `nullptr` `lib` pointer.
*
@@ -130,7 +130,7 @@ void *BKE_id_new(Main *bmain, short type, const char *name);
/**
* Same as for #BKE_id_new, but allows creating a data-block for (within) a given owner library.
*
* \param owner_library the Library to 'assign' the newly created ID to. Use `nullptr` to make ID
* \param owner_library: the Library to 'assign' the newly created ID to. Use `nullptr` to make ID
* not use any library (i.e. become a local ID). Use `std::nullopt` for default behavior (i.e.
* behavior of the #BKE_id_new function).
*/
@@ -223,7 +223,7 @@ void BKE_libblock_copy_ex(Main *bmain, const ID *id, ID **r_newid, int orig_flag
* Same as #BKE_libblock_copy_ex, but allows copying data into a library, and not as local data
* only.
*
* \param owner_library the Library to 'assign' the newly created ID to. Use `nullptr` to make ID
* \param owner_library: the Library to 'assign' the newly created ID to. Use `nullptr` to make ID
* not use any library (i.e. become a local ID). Use std::nullopt for default behavior (i.e.
* behavior of the #BKE_libblock_copy_ex function).
*/
@@ -501,7 +501,7 @@ ID *BKE_id_copy_ex(Main *bmain, const ID *id, ID **r_newid, int flag);
*
* See #BKE_id_copy_ex for details.
*
* \param owner_library the Library to 'assign' the newly created ID to. Use `nullptr` to make ID
* \param owner_library: the Library to 'assign' the newly created ID to. Use `nullptr` to make ID
* not use any library (i.e. become a local ID). Use std::nullopt for default behavior (i.e.
* behavior of the #BKE_id_copy_ex function).
*/

View File

@@ -348,21 +348,21 @@ struct LibQueryUnusedIDsData {
* Amount of detected as unused data-blocks, per type and total as the last value of the array
* (#INDEX_ID_NULL).
*
* \note: Return value, set by the executed function.
* \note Return value, set by the executed function.
*/
std::array<int, INDEX_ID_MAX> num_total;
/**
* Amount of detected as unused local data-blocks, per type and total as the last value of the
* array (#INDEX_ID_NULL).
*
* \note: Return value, set by the executed function.
* \note Return value, set by the executed function.
*/
std::array<int, INDEX_ID_MAX> num_local;
/**
* Amount of detected as unused linked data-blocks, per type and total as the last value of the
* array (#INDEX_ID_NULL).
*
* \note: Return value, set by the executed function.
* \note Return value, set by the executed function.
*/
std::array<int, INDEX_ID_MAX> num_linked;
};

View File

@@ -139,7 +139,7 @@ struct Main {
/** The currently opened .blend file was written from a newer version of Blender, and has forward
* compatibility issues (data loss).
*
* \note: In practice currently this is only based on the version numbers, in the future it
* \note In practice currently this is only based on the version numbers, in the future it
* could try to use more refined detection on load. */
bool has_forward_compatibility_issues;

View File

@@ -559,8 +559,8 @@ void BKE_nla_liboverride_post_process(ID *id, struct AnimData *adt);
/**
* Print the ADT flags, NLA tracks, strips, their flags, and other info, to the console.
*
* \param adt the ADT to show. If NULL, it will be determined from owner_id.
* \param owner_id the ID that owns this ADT. If given, its name will be printed in the console
* \param adt: the ADT to show. If NULL, it will be determined from owner_id.
* \param owner_id: the ID that owns this ADT. If given, its name will be printed in the console
* output. If NULL, that won't happen.
*
* Either of the parameters can be NULL, but not both.

View File

@@ -28,7 +28,7 @@
/**
* Initialize a #ReportList struct.
*
* \note: Not thread-safe, should only be called from the 'owner' thread of the report list.
* \note Not thread-safe, should only be called from the 'owner' thread of the report list.
*/
void BKE_reports_init(ReportList *reports, int flag);
/**
@@ -37,7 +37,7 @@ void BKE_reports_init(ReportList *reports, int flag);
* Also calls #BKE_reports_clear. The given `reports` should not be used anymore unless it is
* re-initialized first.
*
* \note: Not thread-safe, should only be called from the current owner of the report list, once
* \note Not thread-safe, should only be called from the current owner of the report list, once
* no other concurrent access is possible.
*/
void BKE_reports_free(ReportList *reports);

View File

@@ -229,7 +229,7 @@ struct ReuseOldBMainData {
/** Data generated and used by calling WM code to handle keeping WM and UI IDs as best as
* possible across file reading.
*
* \note: May be null in undo (memfile) case.. */
* \note May be null in undo (memfile) case. */
BlendFileReadWMSetupData *wm_setup_data;
/** Storage for all remapping rules (old_id -> new_id) required by the preservation of old IDs

View File

@@ -360,7 +360,7 @@ class AnimDataConvertor {
/**
* Convert relevant FCurves, i.e. modify their RNA path to match destination data.
*
* \note: Edited FCurves will remain in the source animation data after this process. Once all
* \note Edited FCurves will remain in the source animation data after this process. Once all
* source animation data has been processed, #fcurves_convert_finalize has to be called.
*/
void fcurves_convert()

View File

@@ -95,9 +95,9 @@ void BM_mesh_bm_to_me_for_eval(BMesh &bm, Mesh &mesh, const CustomData_MeshMasks
* A version of #BM_mesh_bm_to_me_for_eval but copying data layers and Mesh attributes is optional.
* It also allows shape-keys but don't re-assigns shape-key indices.
*
* \param mask Custom data masks to control which layers are copied.
* If nullptr, no layer data is copied.
* \param add_mesh_attributes If true, adds mesh attributes during the conversion.
* \param mask: Custom data masks to control which layers are copied.
* If nullptr, no layer data is copied.
* \param add_mesh_attributes: If true, adds mesh attributes during the conversion.
*/
void BM_mesh_bm_to_me_compact(BMesh &bm,
Mesh &mesh,

View File

@@ -116,7 +116,7 @@ void Camera::sync()
data.winmat = view.winmat();
data.type = CAMERA_ORTHO;
/* \note: Follow camera parameters where distances are positive in front of the camera. */
/* \note Follow camera parameters where distances are positive in front of the camera. */
data.clip_near = -view.far_clip();
data.clip_far = -view.near_clip();
data.fisheye_fov = data.fisheye_lens = -1.0f;
@@ -191,7 +191,7 @@ void Camera::sync()
is_camera_object_ = true;
}
else if (inst_.drw_view) {
/* \note: Follow camera parameters where distances are positive in front of the camera. */
/* \note Follow camera parameters where distances are positive in front of the camera. */
data.clip_near = -DRW_view_near_distance_get(inst_.drw_view);
data.clip_far = -DRW_view_far_distance_get(inst_.drw_view);
data.fisheye_fov = data.fisheye_lens = -1.0f;

View File

@@ -415,7 +415,7 @@ MaterialArray &MaterialModule::material_array_get(Object *ob, bool has_motion)
for (auto i : IndexRange(materials_len)) {
::Material *blender_mat = material_from_slot(ob, i);
Material &mat = material_sync(ob, blender_mat, to_material_geometry(ob), has_motion);
/* \note: Perform a whole copy since next material_sync() can move the Material memory location
/* \note Perform a whole copy since next material_sync() can move the Material memory location
* (i.e: because of its container growing) */
material_array_.materials.append(mat);
material_array_.gpu_materials.append(mat.shading.gpumat);

View File

@@ -500,7 +500,7 @@ void ShadowDirectional::cascade_tilemaps_distribution(Light &light, const Camera
light.sun.clipmap_base_offset_pos = (offset_vector * (1 << 16)) /
max_ii(levels_range.size() - 1, 1);
/* \note: cascade_level_range starts the range at the unique LOD to apply to all tile-maps. */
/* \note cascade_level_range starts the range at the unique LOD to apply to all tile-maps. */
int level = levels_range.first();
for (int i : IndexRange(levels_range.size())) {
ShadowTileMap *tilemap = tilemaps_[i];

View File

@@ -509,7 +509,7 @@ class ShadowDirectional : public NonCopyable, NonMovable {
static float coverage_get(int lvl)
{
/* This function should be kept in sync with shadow_directional_level(). */
/* \note: If we would to introduce a global scaling option it would be here. */
/* \note If we would to introduce a global scaling option it would be here. */
return exp2(lvl);
}

View File

@@ -90,7 +90,7 @@ int shadow_tile_offset(ivec2 tile, int tiles_index, int lod)
/** \name Load / Store functions.
* \{ */
/** \note: Will clamp if out of bounds. */
/** \note Will clamp if out of bounds. */
ShadowSamplingTile shadow_tile_load(usampler2D tilemaps_tx, ivec2 tile_co, int tilemap_index)
{
/* NOTE(@fclem): This clamp can hide some small imprecision at clip-map transition.

View File

@@ -98,7 +98,7 @@ void ensure_surface_deformation_node_exists(bContext &C, Object &curves_ob);
/**
* Allocate an array of `TransVert` for cursor/selection snapping (See
* `ED_transverts_create_from_obedit` in `view3d_snap.cc`).
* \note: the `TransVert` elements in \a tvs are expected to write to the positions of \a curves.
* \note The `TransVert` elements in \a tvs are expected to write to the positions of \a curves.
*/
void transverts_from_curves_positions_create(bke::CurvesGeometry &curves, TransVertStore *tvs);

View File

@@ -774,7 +774,7 @@ enum {
* - RESET_NEVER: these flags are 'status' ones, and never actually need any reset (except on
* initialization during .blend file reading).
*
* \note: These tags are purely runtime, so changing there value is not an issue. When adding new
* \note These tags are purely runtime, so changing there value is not an issue. When adding new
* tags, please put them in the relevant category and always keep their values strictly increasing.
*/
enum {
@@ -906,7 +906,7 @@ enum {
* ID is being re-used from the old Main (instead of read from memfile), during memfile undo
* processing, because it was detected as unchanged.
*
* \note: Also means that such ID does not need to be lib-linked during undo readfile process.
* \note Also means that such ID does not need to be lib-linked during undo readfile process.
*
* RESET_AFTER_USE
*/
@@ -915,7 +915,7 @@ enum {
* ID is being re-used from the old Main (instead of read from memfile), during memfile undo
* processing, because it is a 'NO_UNDO' type of ID.
*
* \note: Also means that such ID does not need to be lib-linked during undo readfile process. It
* \note Also means that such ID does not need to be lib-linked during undo readfile process. It
* does need to be relinked in a different way however, doing a `session_uid`-based lookup into
* the newly read main database.
*

View File

@@ -210,7 +210,7 @@ typedef struct bNodeTreeInterfacePanel {
/**
* Apply a function to every item in the panel, including child panels.
* \note: The items are visited in drawing order from top to bottom.
* \note The items are visited in drawing order from top to bottom.
*
* \param fn: Function to execute for each item, iterations stops if false is returned.
* \param include_self: Include the panel itself in the iteration.
@@ -400,7 +400,7 @@ typedef struct bNodeTreeInterface {
/**
* Apply a function to every item in the interface.
* \note: The items are visited in drawing order from top to bottom.
* \note The items are visited in drawing order from top to bottom.
*
* \param fn: Function to execute for each item, iterations stops if false is returned.
* \param include_root: Include the root panel in the iteration.
@@ -412,7 +412,7 @@ typedef struct bNodeTreeInterface {
}
/**
* Apply a function to every item in the interface.
* \note: The items are visited in drawing order from top to bottom.
* \note The items are visited in drawing order from top to bottom.
*
* \param fn: Function to execute for each item, iterations stops if false is returned.
* \param include_root: Include the root panel in the iteration.

View File

@@ -163,7 +163,7 @@ struct PropertyRNAOrID {
* Whether this property is defined as a RNA one, but uses an #IDProperty to store its value
* (aka Python-defined runtime RNA properties).
*
* \note: In that case, the IDProperty itself may very well not exist (yet), when it has never
* \note In that case, the IDProperty itself may very well not exist (yet), when it has never
* been set.
*
* \note Mutually exclusive with #is_idprop.

View File

@@ -106,7 +106,7 @@ static void update_depsgraph(ModifierData *md, const ModifierUpdateDepsgraphCont
/**
* Rearrange curve buffers by moving points from the start to the back of each stroke.
* \note This is an optional feature. The offset is determine by the closest point to an object.
* \param curve_offsets Offset of each curve, indicating the point that becomes the new start.
* \param curve_offsets: Offset of each curve, indicating the point that becomes the new start.
*/
static bke::CurvesGeometry reorder_cyclic_curve_points(const bke::CurvesGeometry &src_curves,
const IndexMask &curve_selection,