bmesh operator naming - use clearer names for args eg: (mat -> matrix, use_singleedge...
[blender.git] / source / blender / bmesh / intern / bmesh_operators.c
index 18caefc13c3d93260b09f213987d15e7b2810d02..ba38f230f0b5d5ae0c286aa70445a20230bc0273 100644 (file)
@@ -1485,6 +1485,12 @@ static int bmo_opname_to_opcode(const char *opname)
 /**
  * \brief Format Strings for #BMOperator Initialization.
  *
+ * This system is used to execute or initialize an operator,
+ * using a formatted-string system.
+ *
+ * The basic format for the format string is:
+ * `[operatorname] [slot_name]=%[code] [slot_name]=%[code]`
+ *
  * Example:
  *
  * \code{.c}