Cleanup: doxy sections

This commit is contained in:
2019-08-02 12:25:39 +10:00
parent c060a835bb
commit 14b2c41216
6 changed files with 47 additions and 24 deletions

View File

@@ -64,8 +64,11 @@
#include "armature_intern.h" #include "armature_intern.h"
/* *************************************** Join *************************************** */ /* -------------------------------------------------------------------- */
/* NOTE: no operator define here as this is exported to the Object-level operator */ /** \name Edit Armature Join
*
* \note No operator define here as this is exported to the Object-level operator.
* \{ */
static void joined_armature_fix_links_constraints(Main *bmain, static void joined_armature_fix_links_constraints(Main *bmain,
Object *ob, Object *ob,
@@ -434,7 +437,11 @@ int join_armature_exec(bContext *C, wmOperator *op)
return OPERATOR_FINISHED; return OPERATOR_FINISHED;
} }
/* *********************************** Separate *********************************************** */ /** \} */
/* -------------------------------------------------------------------- */
/** \name Edit Armature Separate
* \{ */
/* Helper function for armature separating - link fixing */ /* Helper function for armature separating - link fixing */
static void separated_armature_fix_links(Main *bmain, Object *origArm, Object *newArm) static void separated_armature_fix_links(Main *bmain, Object *origArm, Object *newArm)
@@ -712,7 +719,11 @@ void ARMATURE_OT_separate(wmOperatorType *ot)
ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO; ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO;
} }
/* ********************************* Parenting ************************************************* */ /** \} */
/* -------------------------------------------------------------------- */
/** \name Edit Armature Parenting
* \{ */
/* armature parenting options */ /* armature parenting options */
#define ARM_PAR_CONNECT 1 #define ARM_PAR_CONNECT 1
@@ -1007,3 +1018,5 @@ void ARMATURE_OT_parent_clear(wmOperatorType *ot)
"ClearType", "ClearType",
"What way to clear parenting"); "What way to clear parenting");
} }
/** \} */

View File

@@ -37,7 +37,6 @@
#include "gpu_py_vertex_format.h" #include "gpu_py_vertex_format.h"
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name Enum Conversion. /** \name Enum Conversion.
* \{ */ * \{ */

View File

@@ -29,7 +29,6 @@
#include "gpu_py_types.h" /* own include */ #include "gpu_py_types.h" /* own include */
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name GPU Types Module /** \name GPU Types Module
* \{ */ * \{ */

View File

@@ -896,8 +896,6 @@ static int cubemap_glob(const float n[3], float x, float y, float z, float *adr1
/* ------------------------------------------------------------------------- */ /* ------------------------------------------------------------------------- */
/* ------------------------------------------------------------------------- */
static void do_2d_mapping( static void do_2d_mapping(
const MTex *mtex, float texvec[3], const float n[3], float dxt[3], float dyt[3]) const MTex *mtex, float texvec[3], const float n[3], float dxt[3], float dyt[3])
{ {

View File

@@ -1061,6 +1061,7 @@ void wm_homefile_read(bContext *C,
} }
} }
/* -------------------------------------------------------------------- */
/** \name WM History File API /** \name WM History File API
* \{ */ * \{ */
@@ -1189,6 +1190,10 @@ static void wm_history_file_update(void)
/** \} */ /** \} */
/* -------------------------------------------------------------------- */
/** \name Save Main .blend File (internal)
* \{ */
/* screen can be NULL */ /* screen can be NULL */
static ImBuf *blend_file_thumb(const bContext *C, static ImBuf *blend_file_thumb(const bContext *C,
Scene *scene, Scene *scene,
@@ -1422,7 +1427,11 @@ static bool wm_file_write(bContext *C, const char *filepath, int fileflags, Repo
return ok; return ok;
} }
/************************ autosave ****************************/ /** \} */
/* -------------------------------------------------------------------- */
/** \name Auto-Save API
* \{ */
void wm_autosave_location(char *filepath) void wm_autosave_location(char *filepath)
{ {
@@ -1550,6 +1559,9 @@ void wm_autosave_read(bContext *C, ReportList *reports)
WM_file_read(C, filename, reports); WM_file_read(C, filename, reports);
} }
/** \} */
/* -------------------------------------------------------------------- */
/** \name Initialize WM_OT_open_xxx properties /** \name Initialize WM_OT_open_xxx properties
* *
* Check if load_ui was set by the caller. * Check if load_ui was set by the caller.
@@ -1593,8 +1605,8 @@ void WM_file_tag_modified(void)
} }
} }
/* -------------------------------------------------------------------- */
/** \name Preferences/startup save & load. /** \name Preferences/startup save & load.
*
* \{ */ * \{ */
/** /**
@@ -2035,8 +2047,8 @@ void WM_OT_read_factory_settings(wmOperatorType *ot)
/** \} */ /** \} */
/** \name Open main .blend file. /* -------------------------------------------------------------------- */
* /** \name Open Main .blend File Utilities
* \{ */ * \{ */
/** /**
@@ -2062,8 +2074,7 @@ static bool wm_file_read_opwrap(bContext *C,
return success; return success;
} }
/* Generic operator state utilities /* Generic operator state utilities */
*********************************************/
static void create_operator_state(wmOperatorType *ot, int first_state) static void create_operator_state(wmOperatorType *ot, int first_state)
{ {
@@ -2101,8 +2112,11 @@ static int operator_state_dispatch(bContext *C, wmOperator *op, OperatorDispatch
return OPERATOR_CANCELLED; return OPERATOR_CANCELLED;
} }
/* Open Mainfile operator /** \} */
********************************************/
/* -------------------------------------------------------------------- */
/** \name Open Main .blend File Operator
* \{ */
enum { enum {
OPEN_MAINFILE_STATE_DISCARD_CHANGES, OPEN_MAINFILE_STATE_DISCARD_CHANGES,
@@ -2326,8 +2340,8 @@ void WM_OT_open_mainfile(wmOperatorType *ot)
/** \} */ /** \} */
/** \name Reload (revert) main .blend file. /* -------------------------------------------------------------------- */
* /** \name Reload (revert) Main .blend File Operator
* \{ */ * \{ */
static int wm_revert_mainfile_exec(bContext *C, wmOperator *op) static int wm_revert_mainfile_exec(bContext *C, wmOperator *op)
@@ -2381,8 +2395,8 @@ void WM_OT_revert_mainfile(wmOperatorType *ot)
/** \} */ /** \} */
/* -------------------------------------------------------------------- */
/** \name Recover last session & auto-save. /** \name Recover last session & auto-save.
*
* \{ */ * \{ */
void WM_recover_last_session(bContext *C, ReportList *reports) void WM_recover_last_session(bContext *C, ReportList *reports)
@@ -2478,8 +2492,8 @@ void WM_OT_recover_auto_save(wmOperatorType *ot)
/** \} */ /** \} */
/** \name Save main .blend file. /* -------------------------------------------------------------------- */
* /** \name Save Main .blend File Operator
* \{ */ * \{ */
static void wm_filepath_default(char *filepath) static void wm_filepath_default(char *filepath)
@@ -2707,8 +2721,8 @@ void WM_OT_save_mainfile(wmOperatorType *ot)
/** \} */ /** \} */
/* -------------------------------------------------------------------- */
/** \name Auto-execution of scripts warning popup /** \name Auto-execution of scripts warning popup
*
* \{ */ * \{ */
static void wm_block_autorun_warning_ignore(bContext *C, void *arg_block, void *UNUSED(arg)) static void wm_block_autorun_warning_ignore(bContext *C, void *arg_block, void *UNUSED(arg))

View File

@@ -383,11 +383,11 @@ fail:
/** \} */ /** \} */
/* -------------------------------------------------------------------- */ /* -------------------------------------------------------------------- */
/** \name Utilities Python Context Macro (#BPY_CTX_SETUP)
* \{ */
# ifdef WITH_PYTHON # ifdef WITH_PYTHON
/** \name Utilities Python Context Macro (#BPY_CTX_SETUP)
* \{ */
struct BlendePyContextStore { struct BlendePyContextStore {
wmWindowManager *wm; wmWindowManager *wm;
Scene *scene; Scene *scene;