Cleanup: use doxy sections

This commit is contained in:
Campbell Barton
2023-09-08 23:09:36 +10:00
parent 2133ee141e
commit 52c4051d13
4 changed files with 94 additions and 15 deletions

View File

@@ -61,6 +61,10 @@
# include "BPY_extern.h"
#endif
/* -------------------------------------------------------------------- */
/** \name ID Type Implementation
* \{ */
static void screen_free_data(ID *id)
{
bScreen *screen = (bScreen *)id;
@@ -189,7 +193,11 @@ IDTypeInfo IDType_ID_SCR = {
/*lib_override_apply_post*/ nullptr,
};
/* ************ Space-type/region-type handling ************** */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Space-type/region-type handling
* \{ */
/** Keep global; this has to be accessible outside of window-manager. */
static ListBase spacetypes = {nullptr, nullptr};
@@ -277,7 +285,11 @@ bool BKE_spacetype_exists(int spaceid)
return BKE_spacetype_from_id(spaceid) != nullptr;
}
/* ***************** Space handling ********************** */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Space handling
* \{ */
void BKE_spacedata_freelist(ListBase *lb)
{
@@ -570,7 +582,11 @@ void BKE_screen_free_data(bScreen *screen)
screen_free_data(&screen->id);
}
/* ***************** Screen edges & verts ***************** */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Screen edges & verts
* \{ */
ScrEdge *BKE_screen_find_edge(const bScreen *screen, ScrVert *v1, ScrVert *v2)
{
@@ -725,7 +741,11 @@ void BKE_screen_remove_unused_scrverts(bScreen *screen)
}
}
/* ***************** Utilities ********************** */
/** \} */
/* -------------------------------------------------------------------- */
/** \name Utilities
* \{ */
ARegion *BKE_region_find_in_listbase_by_type(const ListBase *regionbase, const int region_type)
{
@@ -945,6 +965,12 @@ void BKE_screen_header_alignment_reset(bScreen *screen)
screen->do_refresh = true;
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Blend File IO (Screen & Related Data)
* \{ */
void BKE_screen_view3d_shading_blend_write(BlendWriter *writer, View3DShading *shading)
{
if (shading->prop) {

View File

@@ -1289,6 +1289,8 @@ void GRAPH_OT_match_slope(wmOperatorType *ot)
1.0f);
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Shear Operator
* \{ */
@@ -1546,6 +1548,7 @@ void GRAPH_OT_scale_average(wmOperatorType *ot)
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Gauss Smooth Operator
* \{ */

View File

@@ -31,7 +31,9 @@
/* Own include. */
#include "sequencer_intern.hh"
/*********************** Add modifier operator *************************/
/* -------------------------------------------------------------------- */
/** \name Add modifier operator
* \{ */
static int strip_modifier_add_exec(bContext *C, wmOperator *op)
{
@@ -87,7 +89,11 @@ void SEQUENCER_OT_strip_modifier_add(wmOperatorType *ot)
ot->prop = prop;
}
/*********************** Remove modifier operator *************************/
/** \} */
/* -------------------------------------------------------------------- */
/** \name Remove Modifier Operator
* \{ */
static int strip_modifier_remove_exec(bContext *C, wmOperator *op)
{
@@ -140,7 +146,11 @@ void SEQUENCER_OT_strip_modifier_remove(wmOperatorType *ot)
RNA_def_property_flag(prop, PROP_HIDDEN);
}
/*********************** Move operator *************************/
/** \} */
/* -------------------------------------------------------------------- */
/** \name Move Operator
* \{ */
enum {
SEQ_MODIFIER_MOVE_UP = 0,
@@ -220,7 +230,11 @@ void SEQUENCER_OT_strip_modifier_move(wmOperatorType *ot)
RNA_def_property_flag(prop, PROP_HIDDEN);
}
/*********************** Copy to selected operator *************************/
/** \} */
/* -------------------------------------------------------------------- */
/** \name Copy to Selected Operator
* \{ */
enum {
SEQ_MODIFIER_COPY_REPLACE = 0,
@@ -313,6 +327,12 @@ void SEQUENCER_OT_strip_modifier_copy(wmOperatorType *ot)
ot->prop = RNA_def_enum(ot->srna, "type", type_items, SEQ_MODIFIER_COPY_REPLACE, "Type", "");
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Redefine Equalizer Graphs Operator
* \{ */
static int strip_modifier_equalizer_redefine_exec(bContext *C, wmOperator *op)
{
Scene *scene = CTX_data_scene(C);
@@ -369,3 +389,5 @@ void SEQUENCER_OT_strip_modifier_equalizer_redefine(wmOperatorType *ot)
ot->srna, "name", "Name", MAX_NAME, "Name", "Name of modifier to redefine");
RNA_def_property_flag(prop, PROP_HIDDEN);
}
/** \} */

View File

@@ -46,7 +46,9 @@
#include "render_result.h"
#include "render_types.h"
/********************************** Free *************************************/
/* -------------------------------------------------------------------- */
/** \name Free
* \{ */
static void render_result_views_free(RenderResult *rr)
{
@@ -122,7 +124,11 @@ void render_result_free_gpu_texture_caches(RenderResult *rr)
}
}
/********************************* multiview *************************************/
/** \} */
/* -------------------------------------------------------------------- */
/** \name Multi-View
* \{ */
void render_result_views_shallowcopy(RenderResult *dst, RenderResult *src)
{
@@ -155,7 +161,11 @@ void render_result_views_shallowdelete(RenderResult *rr)
}
}
/********************************** New **************************************/
/** \} */
/* -------------------------------------------------------------------- */
/** \name New
* \{ */
static void render_layer_allocate_pass(RenderResult *rr, RenderPass *rp)
{
@@ -729,7 +739,11 @@ void render_result_views_new(RenderResult *rr, const RenderData *rd)
}
}
/*********************************** Merge ***********************************/
/** \} */
/* -------------------------------------------------------------------- */
/** \name Merge
* \{ */
static void do_merge_tile(
RenderResult *rr, RenderResult *rrpart, float *target, float *tile, int pixsize)
@@ -792,7 +806,11 @@ void render_result_merge(RenderResult *rr, RenderResult *rrpart)
}
}
/**************************** Single Layer Rendering *************************/
/** \} */
/* -------------------------------------------------------------------- */
/** \name Single Layer Rendering
* \{ */
void render_result_single_layer_begin(Render *re)
{
@@ -1019,7 +1037,11 @@ bool render_result_exr_file_cache_read(Render *re)
return true;
}
/*************************** Combined Pixel Rect *****************************/
/** \} */
/* -------------------------------------------------------------------- */
/** \name Combined Pixel Rect
* \{ */
ImBuf *RE_render_result_rect_to_ibuf(RenderResult *rr,
const ImageFormatData *imf,
@@ -1159,7 +1181,11 @@ void render_result_rect_get_pixels(RenderResult *rr,
}
}
/*************************** multiview functions *****************************/
/** \} */
/* -------------------------------------------------------------------- */
/** \name Multi-View Functions
* \{ */
bool RE_HasCombinedLayer(const RenderResult *result)
{
@@ -1289,3 +1315,5 @@ ImBuf *RE_RenderViewEnsureImBuf(const RenderResult *render_result, RenderView *r
return render_view->ibuf;
}
/** \} */