From 4fc5d287acc2f599f5e5581d7d13a7c11679e5b6 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Fri, 8 Sep 2023 16:53:30 +1000 Subject: [PATCH] Cleanup: doxygen parameters, blank comment lines --- intern/audaspace/intern/AUD_Set.h | 12 ++++++------ intern/ghost/GHOST_ISystem.hh | 1 - intern/ghost/intern/GHOST_System.hh | 1 - source/blender/blenkernel/BKE_blender_version.h | 6 +++--- source/blender/blenkernel/BKE_constraint.h | 2 +- source/blender/blenkernel/BKE_pbvh_api.hh | 1 - source/blender/blenlib/BLI_convexhull_2d.h | 1 - source/blender/blenlib/BLI_index_mask.hh | 1 - source/blender/blenloader/BLO_readfile.h | 3 ++- .../gpu_shader_compositor_image_diagonals.glsl | 3 --- .../engines/eevee_next/eevee_ambient_occlusion.hh | 1 - .../draw/engines/eevee_next/eevee_subsurface.cc | 2 -- .../blender/draw/engines/eevee_next/eevee_volume.cc | 1 - .../blender/draw/engines/select/select_instance.hh | 1 - source/blender/editors/include/ED_keyframes_edit.hh | 2 +- source/blender/editors/include/UI_interface.hh | 1 - .../editors/sculpt_paint/grease_pencil_erase.cc | 1 - source/blender/editors/space_graph/graph_draw.cc | 4 ++-- source/blender/gpu/GPU_texture.h | 1 - source/blender/makesdna/DNA_grease_pencil_types.h | 3 +-- source/blender/makesdna/intern/makesdna.cc | 1 - 21 files changed, 16 insertions(+), 33 deletions(-) diff --git a/intern/audaspace/intern/AUD_Set.h b/intern/audaspace/intern/AUD_Set.h index 4d7a44562f8..e877b3a7d3c 100644 --- a/intern/audaspace/intern/AUD_Set.h +++ b/intern/audaspace/intern/AUD_Set.h @@ -21,28 +21,28 @@ extern void *AUD_createSet(void); /** * Deletes a set. - * \param set The set to delete. + * \param set: The set to delete. */ extern void AUD_destroySet(void *set); /** * Removes an entry from a set. - * \param set The set work on. - * \param entry The entry to remove. + * \param set: The set work on. + * \param entry: The entry to remove. * \return Whether the entry was in the set or not. */ extern char AUD_removeSet(void *set, void *entry); /** * Adds a new entry to a set. - * \param set The set work on. - * \param entry The entry to add. + * \param set: The set work on. + * \param entry: The entry to add. */ extern void AUD_addSet(void *set, void *entry); /** * Removes one entry from a set and returns it. - * \param set The set work on. + * \param set: The set work on. * \return The entry or NULL if the set is empty. */ extern void *AUD_getSet(void *set); diff --git a/intern/ghost/GHOST_ISystem.hh b/intern/ghost/GHOST_ISystem.hh index 59df6208da6..9ecde8bdaa6 100644 --- a/intern/ghost/GHOST_ISystem.hh +++ b/intern/ghost/GHOST_ISystem.hh @@ -473,7 +473,6 @@ class GHOST_ISystem { /** * Returns the selection buffer * \return "unsigned char" from X11 XA_CUT_BUFFER0 buffer - * */ virtual char *getClipboard(bool selection) const = 0; diff --git a/intern/ghost/intern/GHOST_System.hh b/intern/ghost/intern/GHOST_System.hh index bb4688f865f..3bfaa370028 100644 --- a/intern/ghost/intern/GHOST_System.hh +++ b/intern/ghost/intern/GHOST_System.hh @@ -327,7 +327,6 @@ class GHOST_System : public GHOST_ISystem { * Returns the selection buffer * \param selection: Only used on X11. * \return Returns the clipboard data - * */ virtual char *getClipboard(bool selection) const = 0; diff --git a/source/blender/blenkernel/BKE_blender_version.h b/source/blender/blenkernel/BKE_blender_version.h index 0bc34afb0b5..70097cf4137 100644 --- a/source/blender/blenkernel/BKE_blender_version.h +++ b/source/blender/blenkernel/BKE_blender_version.h @@ -49,10 +49,10 @@ bool BKE_blender_version_is_alpha(void); * Fill in given string buffer with user-readable formatted file version and subversion (if * provided). * - * \param str_buff a char buffer where the formatted string is written, minimal recommended size is - * 8, or 16 if subversion is provided. + * \param str_buff: a char buffer where the formatted string is written, + * minimal recommended size is 8, or 16 if subversion is provided. * - * \param file_subversion the file subversion, if given value < 0, it is ignored, and only the + * \param file_subversion: the file subversion, if given value < 0, it is ignored, and only the * `file_version` is used. */ void BKE_blender_version_blendfile_string_from_values(char *str_buff, diff --git a/source/blender/blenkernel/BKE_constraint.h b/source/blender/blenkernel/BKE_constraint.h index d475f65fa82..5396a503ac5 100644 --- a/source/blender/blenkernel/BKE_constraint.h +++ b/source/blender/blenkernel/BKE_constraint.h @@ -179,7 +179,7 @@ void BKE_constraints_copy_ex(struct ListBase *dst, /** * Run the given callback on all ID-blocks in list of constraints. * - * \param flag the `IDWALK_` flags controlling the behavior of the foreach_id code, see + * \param flag: the `IDWALK_` flags controlling the behavior of the foreach_id code, see * `BKE_lib_query.h` */ void BKE_constraints_id_loop(struct ListBase *list, diff --git a/source/blender/blenkernel/BKE_pbvh_api.hh b/source/blender/blenkernel/BKE_pbvh_api.hh index f1d3e854aa8..fd463bffd01 100644 --- a/source/blender/blenkernel/BKE_pbvh_api.hh +++ b/source/blender/blenkernel/BKE_pbvh_api.hh @@ -275,7 +275,6 @@ bool BKE_pbvh_bmesh_node_raycast_detail(PBVHNode *node, * projecting the far clipping plane into the local object space. This works out to * dividing view3d->clip_end by the object scale, which for small object and large * clip_end's can easily lead to floating-point overflows. - * */ void BKE_pbvh_clip_ray_ortho( PBVH *pbvh, bool original, float ray_start[3], float ray_end[3], float ray_normal[3]); diff --git a/source/blender/blenlib/BLI_convexhull_2d.h b/source/blender/blenlib/BLI_convexhull_2d.h index a34cf1ab989..dafc00c0445 100644 --- a/source/blender/blenlib/BLI_convexhull_2d.h +++ b/source/blender/blenlib/BLI_convexhull_2d.h @@ -21,7 +21,6 @@ extern "C" { * \return The number of indices in r_points. * * \note Performance is `O(n.log(n))`, same as `qsort`. - * */ int BLI_convexhull_2d(const float (*points)[2], int n, int r_points[/* n */]); diff --git a/source/blender/blenlib/BLI_index_mask.hh b/source/blender/blenlib/BLI_index_mask.hh index ec241bb4f9b..5c975352f5a 100644 --- a/source/blender/blenlib/BLI_index_mask.hh +++ b/source/blender/blenlib/BLI_index_mask.hh @@ -161,7 +161,6 @@ using IndexMaskSegment = OffsetSpan; * * Extraction: * An #IndexMask can be converted into various other forms using the `to_*` methods. - * */ class IndexMask : private IndexMaskData { public: diff --git a/source/blender/blenloader/BLO_readfile.h b/source/blender/blenloader/BLO_readfile.h index 1df91f43cdd..91311bfbcf6 100644 --- a/source/blender/blenloader/BLO_readfile.h +++ b/source/blender/blenloader/BLO_readfile.h @@ -203,7 +203,8 @@ void BLO_blendfiledata_free(BlendFileData *bfd); * * Called at the end of #setup_add_data from BKE's `blendfile.cc`. * - * \param new_bmain the newly read Main data-base. */ + * \param new_bmain: the newly read Main data-base. + */ void BLO_read_do_version_after_setup(struct Main *new_bmain, struct BlendFileReadReport *reports); /** \} */ diff --git a/source/blender/compositor/realtime_compositor/shaders/library/gpu_shader_compositor_image_diagonals.glsl b/source/blender/compositor/realtime_compositor/shaders/library/gpu_shader_compositor_image_diagonals.glsl index cd8ff8c14eb..d135ed48cd2 100644 --- a/source/blender/compositor/realtime_compositor/shaders/library/gpu_shader_compositor_image_diagonals.glsl +++ b/source/blender/compositor/realtime_compositor/shaders/library/gpu_shader_compositor_image_diagonals.glsl @@ -58,7 +58,6 @@ int compute_number_of_diagonals(ivec2 size) * all share the same maximum value, that is, the longest length: * * Length => min(Longest Length, index + 1, Number Of Diagonals - index) - * */ int compute_diagonal_length(ivec2 size, int diagonal_index) { @@ -94,7 +93,6 @@ int compute_diagonal_length(ivec2 size, int diagonal_index) * while other indices are zero. Which can be described using the compact equation: * * Y => max(0, (height - 1) - index) - * */ ivec2 compute_diagonal_start(ivec2 size, int index) { @@ -158,7 +156,6 @@ int compute_anti_diagonal_length(ivec2 size, int diagonal_index) * from zero to (height - 1). Which can be described using the compact equation: * * Y => max(0, index - (width - 1)) - * */ ivec2 compute_anti_diagonal_start(ivec2 size, int index) { diff --git a/source/blender/draw/engines/eevee_next/eevee_ambient_occlusion.hh b/source/blender/draw/engines/eevee_next/eevee_ambient_occlusion.hh index c6f222e246f..dc3c52715c9 100644 --- a/source/blender/draw/engines/eevee_next/eevee_ambient_occlusion.hh +++ b/source/blender/draw/engines/eevee_next/eevee_ambient_occlusion.hh @@ -10,7 +10,6 @@ * Based on Practical Realtime Strategies for Accurate Indirect Occlusion * http://blog.selfshadow.com/publications/s2016-shading-course/activision/s2016_pbs_activision_occlusion.pdf * http://blog.selfshadow.com/publications/s2016-shading-course/activision/s2016_pbs_activision_occlusion.pptx - * */ #pragma once diff --git a/source/blender/draw/engines/eevee_next/eevee_subsurface.cc b/source/blender/draw/engines/eevee_next/eevee_subsurface.cc index a7a56ab0f66..6de262ef82a 100644 --- a/source/blender/draw/engines/eevee_next/eevee_subsurface.cc +++ b/source/blender/draw/engines/eevee_next/eevee_subsurface.cc @@ -4,7 +4,6 @@ /** \file * \ingroup eevee - * */ #include "BLI_vector.hh" @@ -18,7 +17,6 @@ namespace blender::eevee { /* -------------------------------------------------------------------- */ /** \name Subsurface - * * \{ */ void SubsurfaceModule::end_sync() diff --git a/source/blender/draw/engines/eevee_next/eevee_volume.cc b/source/blender/draw/engines/eevee_next/eevee_volume.cc index 2cb6dc0bb7b..ca534830cb0 100644 --- a/source/blender/draw/engines/eevee_next/eevee_volume.cc +++ b/source/blender/draw/engines/eevee_next/eevee_volume.cc @@ -8,7 +8,6 @@ * Volumetric effects rendering using Frostbite's Physically-based & Unified Volumetric Rendering * approach. * https://www.ea.com/frostbite/news/physically-based-unified-volumetric-rendering-in-frostbite - * */ #include "DNA_volume_types.h" diff --git a/source/blender/draw/engines/select/select_instance.hh b/source/blender/draw/engines/select/select_instance.hh index 214120a36cf..f612f480000 100644 --- a/source/blender/draw/engines/select/select_instance.hh +++ b/source/blender/draw/engines/select/select_instance.hh @@ -4,7 +4,6 @@ /** \file * \ingroup draw_engine - * */ #pragma once diff --git a/source/blender/editors/include/ED_keyframes_edit.hh b/source/blender/editors/include/ED_keyframes_edit.hh index 2e60d29e256..f48ae110f7d 100644 --- a/source/blender/editors/include/ED_keyframes_edit.hh +++ b/source/blender/editors/include/ED_keyframes_edit.hh @@ -470,7 +470,7 @@ void shear_fcurve_segment(struct FCurve *fcu, * Shift the FCurve segment up/down so that it aligns with the key before/after * the segment. * - * \param factor blend factor from -1.0 to 1.0. The sign determines whether the + * \param factor: blend factor from -1.0 to 1.0. The sign determines whether the * segment is aligned with the key before or after the segment. */ void blend_offset_fcurve_segment(FCurve *fcu, FCurveSegment *segment, float factor); diff --git a/source/blender/editors/include/UI_interface.hh b/source/blender/editors/include/UI_interface.hh index ea557eaf821..cc0e4adc83a 100644 --- a/source/blender/editors/include/UI_interface.hh +++ b/source/blender/editors/include/UI_interface.hh @@ -124,7 +124,6 @@ struct DragInfo { * #wmDropBox is needed to request instances of it from a UI element and call its functions. For * example the drop box using "UI_OT_view_drop" implements dropping for views and view items via * this interface. To support other kinds of UI elements, similar drop boxes would be necessary. - * */ class DropTargetInterface { public: diff --git a/source/blender/editors/sculpt_paint/grease_pencil_erase.cc b/source/blender/editors/sculpt_paint/grease_pencil_erase.cc index 792c7699a58..5dc37c10bf7 100644 --- a/source/blender/editors/sculpt_paint/grease_pencil_erase.cc +++ b/source/blender/editors/sculpt_paint/grease_pencil_erase.cc @@ -376,7 +376,6 @@ struct EraseOperationExecutor { * source geometry, with the given \a factor. * A point in the destination is a \a cut if it splits the source curves geometry, meaning it is * the first point of a new curve in the destination. - * */ struct PointTransferData { int src_point; diff --git a/source/blender/editors/space_graph/graph_draw.cc b/source/blender/editors/space_graph/graph_draw.cc index b74395251ed..ada31303722 100644 --- a/source/blender/editors/space_graph/graph_draw.cc +++ b/source/blender/editors/space_graph/graph_draw.cc @@ -865,8 +865,8 @@ static int calculate_bezt_draw_resolution(BezTriple *bezt, } /** - * Add points on the bezier between \param prevbezt and \param bezt to \param curve_vertices. The - * amount of points added is based on the given \param resolution. + * Add points on the bezier between `prevbezt` and `bezt` to `curve_vertices`. + * The amount of points added is based on the given `resolution`. */ static void add_bezt_vertices(BezTriple *bezt, BezTriple *prevbezt, diff --git a/source/blender/gpu/GPU_texture.h b/source/blender/gpu/GPU_texture.h index feba96bed85..0190770f082 100644 --- a/source/blender/gpu/GPU_texture.h +++ b/source/blender/gpu/GPU_texture.h @@ -174,7 +174,6 @@ typedef enum GPUSamplerStateType { * GPU_texture_compare_mode(texture, true); * // Use the texture ... * GPU_texture_compare_mode(texture, false); - * */ typedef struct GPUSamplerState { /** Specifies the enabled filtering options for the sampler. */ diff --git a/source/blender/makesdna/DNA_grease_pencil_types.h b/source/blender/makesdna/DNA_grease_pencil_types.h index 5d366027063..40cbfb17f54 100644 --- a/source/blender/makesdna/DNA_grease_pencil_types.h +++ b/source/blender/makesdna/DNA_grease_pencil_types.h @@ -502,12 +502,11 @@ typedef struct GreasePencil { /** * Move a set of frames in a \a layer. * - * \param frame_number_destinations describes all transformations that should be applied on the + * \param frame_number_destinations: describes all transformations that should be applied on the * frame keys. * * If a transformation overlaps another frames, the frame will be overwritten, and the * corresponding drawing may be removed, if it no longer has users. - * */ void move_frames(blender::bke::greasepencil::Layer &layer, const blender::Map &frame_number_destinations); diff --git a/source/blender/makesdna/intern/makesdna.cc b/source/blender/makesdna/intern/makesdna.cc index 0a43aaab771..31cab2c1b5d 100644 --- a/source/blender/makesdna/intern/makesdna.cc +++ b/source/blender/makesdna/intern/makesdna.cc @@ -543,7 +543,6 @@ static bool match_preproc_prefix(const char *__restrict str, const char *__restr /** * \return The point in `str` that starts with `start` or nullptr when not found. - * */ static char *match_preproc_strstr(char *__restrict str, const char *__restrict start) {