From aa500c4fcabe7dad834b91572c75bee760041ede Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 2 Mar 2022 12:07:18 +1100 Subject: Cleanup: use back-slash for doxygen commands, color after parameters --- source/blender/blenkernel/BKE_lib_remap.h | 2 +- source/blender/editors/sculpt_paint/sculpt_intern.h | 6 +++--- source/blender/editors/space_outliner/tree/tree_element.hh | 4 ++-- .../functions/FN_multi_function_procedure_optimization.hh | 6 +++--- source/blender/gpu/intern/gpu_shader_create_info.hh | 2 +- source/blender/imbuf/IMB_imbuf.h | 12 ++++++------ source/blender/io/wavefront_obj/exporter/obj_export_io.hh | 2 +- source/blender/io/wavefront_obj/exporter/obj_export_mesh.hh | 2 +- 8 files changed, 18 insertions(+), 18 deletions(-) (limited to 'source') diff --git a/source/blender/blenkernel/BKE_lib_remap.h b/source/blender/blenkernel/BKE_lib_remap.h index 94b94303ec9..fd7d39fc250 100644 --- a/source/blender/blenkernel/BKE_lib_remap.h +++ b/source/blender/blenkernel/BKE_lib_remap.h @@ -220,7 +220,7 @@ IDRemapperApplyResult BKE_id_remapper_apply(const struct IDRemapper *id_remapper * Use this function when `ID_REMAP_APPLY_UNMAP_WHEN_REMAPPING_TO_SELF`. In this case * the #id_self parameter is required. Otherwise the #BKE_id_remapper_apply can be used. * - * \param id_self required for ID_REMAP_APPLY_UNMAP_WHEN_REMAPPING_TO_SELF. + * \param id_self: required for ID_REMAP_APPLY_UNMAP_WHEN_REMAPPING_TO_SELF. * When remapping to id_self it will then be remapped to NULL. */ IDRemapperApplyResult BKE_id_remapper_apply_ex(const struct IDRemapper *id_remapper, diff --git a/source/blender/editors/sculpt_paint/sculpt_intern.h b/source/blender/editors/sculpt_paint/sculpt_intern.h index a6b412b2b7e..6f9df4d8252 100644 --- a/source/blender/editors/sculpt_paint/sculpt_intern.h +++ b/source/blender/editors/sculpt_paint/sculpt_intern.h @@ -1105,10 +1105,10 @@ bool SCULPT_search_sphere_cb(PBVHNode *node, void *data_v); bool SCULPT_search_circle_cb(PBVHNode *node, void *data_v); /** - * Initialize a point-in-brush test with a given falloff shape + * Initialize a point-in-brush test with a given falloff shape. * - * \param falloff_shape PAINT_FALLOFF_SHAPE_SPHERE or PAINT_FALLOFF_SHAPE_TUBE - * \return The brush falloff function + * \param falloff_shape: #PAINT_FALLOFF_SHAPE_SPHERE or #PAINT_FALLOFF_SHAPE_TUBE. + * \return The brush falloff function. */ SculptBrushTestFn SCULPT_brush_test_init_with_falloff_shape(SculptSession *ss, SculptBrushTest *test, diff --git a/source/blender/editors/space_outliner/tree/tree_element.hh b/source/blender/editors/space_outliner/tree/tree_element.hh index 996f51eee82..2fbc86705b9 100644 --- a/source/blender/editors/space_outliner/tree/tree_element.hh +++ b/source/blender/editors/space_outliner/tree/tree_element.hh @@ -89,8 +89,8 @@ void tree_element_expand(const AbstractTreeElement &tree_element, SpaceOutliner /** * Get actual warning data of a tree element, if any. * - * \param r_icon The icon to display as warning. - * \param r_message The message to display as warning. + * \param r_icon: The icon to display as warning. + * \param r_message: The message to display as warning. * \return true if there is a warning, false otherwise. */ bool tree_element_warnings_get(struct TreeElement *te, int *r_icon, const char **r_message); diff --git a/source/blender/functions/FN_multi_function_procedure_optimization.hh b/source/blender/functions/FN_multi_function_procedure_optimization.hh index 6e1e804c804..f5a02d84d42 100644 --- a/source/blender/functions/FN_multi_function_procedure_optimization.hh +++ b/source/blender/functions/FN_multi_function_procedure_optimization.hh @@ -38,9 +38,9 @@ namespace blender::fn::procedure_optimization { * For simplicity, and because this is the most common use case, this optimization currently only * works on a single chain of instructions. Destruct instructions are not moved across branches. * - * \param procedure The procedure that should be optimized. - * \param block_end_instr The instruction that points to the last instruction within a linear chain - * of instructions. The algorithm moves instructions backward starting at this instruction. + * \param procedure: The procedure that should be optimized. + * \param block_end_instr: The instruction that points to the last instruction within a linear + * chain of instructions. The algorithm moves instructions backward starting at this instruction. */ void move_destructs_up(MFProcedure &procedure, MFInstruction &block_end_instr); diff --git a/source/blender/gpu/intern/gpu_shader_create_info.hh b/source/blender/gpu/intern/gpu_shader_create_info.hh index e05dce57674..bf74d44d9a7 100644 --- a/source/blender/gpu/intern/gpu_shader_create_info.hh +++ b/source/blender/gpu/intern/gpu_shader_create_info.hh @@ -255,7 +255,7 @@ struct StageInterfaceInfo { }; /** - * @brief Describe inputs & outputs, stage interfaces, resources and sources of a shader. + * \brief Describe inputs & outputs, stage interfaces, resources and sources of a shader. * If all data is correctly provided, this is all that is needed to create and compile * a GPUShader. * diff --git a/source/blender/imbuf/IMB_imbuf.h b/source/blender/imbuf/IMB_imbuf.h index 6b35e84ca51..8929a467670 100644 --- a/source/blender/imbuf/IMB_imbuf.h +++ b/source/blender/imbuf/IMB_imbuf.h @@ -900,16 +900,16 @@ typedef enum eIMBTransformMode { /** * \brief Transform source image buffer onto destination image buffer using a transform matrix. * - * \param src Image buffer to read from. - * \param dst Image buffer to write to. rect or rect_float must already be initialized. + * \param src: Image buffer to read from. + * \param dst: Image buffer to write to. rect or rect_float must already be initialized. * - dst buffer must be a 4 channel buffers. * - Only one data type buffer will be used (rect_float has priority over rect) - * \param mode Cropping/Wrap repeat effect to apply during transformation. - * \param filter Interpolation to use during sampling. - * \param transform_matrix Transformation matrix to use. + * \param mode: Cropping/Wrap repeat effect to apply during transformation. + * \param filter: Interpolation to use during sampling. + * \param transform_matrix: Transformation matrix to use. * The given matrix should transform between dst pixel space to src pixel space. * One unit is one pixel. - * \param src_crop cropping region how to crop the source buffer. Should only be passed when mode + * \param src_crop: Cropping region how to crop the source buffer. Should only be passed when mode * is set to #IMB_TRANSFORM_MODE_CROP_SRC. For any other mode this should be empty. * * During transformation no data/color conversion will happens. diff --git a/source/blender/io/wavefront_obj/exporter/obj_export_io.hh b/source/blender/io/wavefront_obj/exporter/obj_export_io.hh index 7016dff2a29..3bee93b36a5 100644 --- a/source/blender/io/wavefront_obj/exporter/obj_export_io.hh +++ b/source/blender/io/wavefront_obj/exporter/obj_export_io.hh @@ -310,7 +310,7 @@ class FormatHandler : NonCopyable, NonMovable { /** * Example invocation: `writer->write("foo")`. * - * \param key Must match what the instance's filetype expects; i.e., `eMTLSyntaxElement` for + * \param key: Must match what the instance's filetype expects; i.e., `eMTLSyntaxElement` for * `eFileType::MTL`. */ template::SyntaxType key, typename... T> diff --git a/source/blender/io/wavefront_obj/exporter/obj_export_mesh.hh b/source/blender/io/wavefront_obj/exporter/obj_export_mesh.hh index 9b9c8483464..5b11c85b7a4 100644 --- a/source/blender/io/wavefront_obj/exporter/obj_export_mesh.hh +++ b/source/blender/io/wavefront_obj/exporter/obj_export_mesh.hh @@ -189,7 +189,7 @@ class OBJMesh : NonCopyable { } /** * Calculate a polygon's polygon/loop normal indices. - * \param poly_index Index of the polygon to calculate indices for. + * \param poly_index: Index of the polygon to calculate indices for. * \return Vector of normal indices, aligned with vertices of polygon. */ Vector calc_poly_normal_indices(int poly_index) const; -- cgit v1.2.3