Cleanup: use back-slash for doxygen commands, color after parameters

This commit is contained in:
Campbell Barton 2022-03-02 12:07:18 +11:00
parent eabdcdcd44
commit aa500c4fca
12 changed files with 22 additions and 22 deletions

View File

@ -253,7 +253,7 @@ extern int GHOST_GetFullScreen(GHOST_SystemHandle systemhandle);
* Get the Window under the cursor.
* \param x: The x-coordinate of the cursor.
* \param y: The y-coordinate of the cursor.
* @return The window under the cursor or nullptr in none.
* \return The window under the cursor or nullptr in none.
*/
extern GHOST_WindowHandle GHOST_GetWindowUnderCursor(GHOST_SystemHandle systemhandle,
int32_t x,

View File

@ -313,7 +313,7 @@ class GHOST_ISystem {
* Get the Window under the cursor.
* \param x: The x-coordinate of the cursor.
* \param y: The y-coordinate of the cursor.
* @return The window under the cursor or nullptr if none.
* \return The window under the cursor or nullptr if none.
*/
virtual GHOST_IWindow *getWindowUnderCursor(int32_t x, int32_t y) = 0;

View File

@ -161,7 +161,7 @@ class GHOST_System : public GHOST_ISystem {
* Get the Window under the cursor.
* \param x: The x-coordinate of the cursor.
* \param y: The y-coordinate of the cursor.
* @return The window under the cursor or nullptr if none.
* \return The window under the cursor or nullptr if none.
*/
GHOST_IWindow *getWindowUnderCursor(int32_t x, int32_t y);

View File

@ -113,7 +113,7 @@ class GHOST_SystemCocoa : public GHOST_System {
* Get the Window under the cursor.
* \param x: The x-coordinate of the cursor.
* \param y: The y-coordinate of the cursor.
* @return The window under the cursor or nullptr if none.
* \return The window under the cursor or nullptr if none.
*/
GHOST_IWindow *getWindowUnderCursor(int32_t x, int32_t y);

View File

@ -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,

View File

@ -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,

View File

@ -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);

View File

@ -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);

View File

@ -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.
*

View File

@ -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.

View File

@ -310,7 +310,7 @@ class FormatHandler : NonCopyable, NonMovable {
/**
* Example invocation: `writer->write<eMTLSyntaxElement::newmtl>("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<typename FileTypeTraits<filetype>::SyntaxType key, typename... T>

View File

@ -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<int> calc_poly_normal_indices(int poly_index) const;