Cleanup: Add docs to lasso and line gesture

This PR adds an explanation to the Lasso Gesture doxygen
section of the generic `wm_gesture_ops.cc` file.

Pull Request: https://projects.blender.org/blender/blender/pulls/119490
This commit is contained in:
Sean Kim 2024-03-15 00:27:12 +01:00 • committed by Hans Goudey
parent d07d6f1c10
commit 2e6a8ae49c

View file

@ -474,6 +474,11 @@ void WM_OT_circle_gesture(wmOperatorType *ot)
/* -------------------------------------------------------------------- */
/** \name Lasso Gesture
* There are two types of lasso gesture:
* 1. #WM_GESTURE_LASSO: A lasso that follows the mouse cursor with the enclosed area shaded.
* 2. #WM_GESTURE_LINES: A lasso that follows the mouse cursor without the enclosed area shaded.
*
* The operator stores data in the "path" property as a series of screen space positions.
* \{ */
int WM_gesture_lasso_invoke(bContext *C, wmOperator *op, const wmEvent *event)