Cleanup: don't use DOXYGEN blocks for inline comments

This commit is contained in:
Campbell Barton
2023-10-11 10:49:07 +11:00
parent b0a6c6c1de
commit 91ec9bc5a7
5 changed files with 21 additions and 23 deletions

View File

@@ -1380,8 +1380,7 @@ void BM_mesh_decimate_collapse(BMesh *bm,
while ((bm->totface > face_tot_target) && (BLI_heap_is_empty(eheap) == false) &&
(BLI_heap_top_value(eheap) != COST_INVALID))
{
/**
* \note
/* NOTE:
* - `eheap_table[e_index_mirr]` is only removed from the heap at the last moment
* since its possible (in theory) for collapsing `e` to remove `e_mirr`.
* - edges sharing a vertex are ignored, so the pivot vertex isn't moved to one side.

View File

@@ -857,7 +857,7 @@ void ShadowModule::begin_sync()
}
{
/** Use depth buffer to tag needed shadow pages for opaque geometry. */
/* Use depth buffer to tag needed shadow pages for opaque geometry. */
PassMain::Sub &sub = pass.sub("Opaque");
sub.shader_set(inst_.shaders.static_shader_get(SHADOW_TILEMAP_TAG_USAGE_OPAQUE));
sub.bind_ssbo("tilemaps_buf", &tilemap_pool.tilemaps_data);
@@ -868,7 +868,7 @@ void ShadowModule::begin_sync()
sub.dispatch(&dispatch_depth_scan_size_);
}
{
/** Use bounding boxes for transparent geometry. */
/* Use bounding boxes for transparent geometry. */
PassMain::Sub &sub = pass.sub("Transparent");
/* WORKAROUND: The DRW_STATE_WRITE_STENCIL is here only to avoid enabling the rasterizer
* discard inside draw manager. */
@@ -1012,7 +1012,7 @@ void ShadowModule::end_sync()
pass.init();
{
/** Clear tile-map clip buffer. */
/* Clear tile-map clip buffer. */
PassSimple::Sub &sub = pass.sub("ClearClipmap");
sub.shader_set(inst_.shaders.static_shader_get(SHADOW_CLIPMAP_CLEAR));
sub.bind_ssbo("tilemaps_clip_buf", tilemap_pool.tilemaps_clip);
@@ -1023,7 +1023,7 @@ void ShadowModule::end_sync()
}
{
/** Compute near/far clip distances for directional shadows based on casters bounds. */
/* Compute near/far clip distances for directional shadows based on casters bounds. */
PassSimple::Sub &sub = pass.sub("DirectionalBounds");
sub.shader_set(inst_.shaders.static_shader_get(SHADOW_TILEMAP_BOUNDS));
sub.bind_ssbo("tilemaps_buf", tilemap_pool.tilemaps_data);
@@ -1039,7 +1039,7 @@ void ShadowModule::end_sync()
sub.barrier(GPU_BARRIER_SHADER_STORAGE);
}
{
/** Clear usage bits. Tag update from the tile-map for sun shadow clip-maps shifting. */
/* Clear usage bits. Tag update from the tile-map for sun shadow clip-maps shifting. */
PassSimple::Sub &sub = pass.sub("Init");
sub.shader_set(inst_.shaders.static_shader_get(SHADOW_TILEMAP_INIT));
sub.bind_ssbo("tilemaps_buf", tilemap_pool.tilemaps_data);
@@ -1047,7 +1047,7 @@ void ShadowModule::end_sync()
sub.bind_ssbo("tiles_buf", tilemap_pool.tiles_data);
sub.bind_ssbo("pages_cached_buf", pages_cached_data_);
sub.dispatch(int3(1, 1, tilemap_pool.tilemaps_data.size()));
/** Free unused tiles from tile-maps not used by any shadow. */
/* Free unused tiles from tile-maps not used by any shadow. */
if (tilemap_pool.tilemaps_unused.size() > 0) {
sub.bind_ssbo("tilemaps_buf", tilemap_pool.tilemaps_unused);
sub.dispatch(int3(1, 1, tilemap_pool.tilemaps_unused.size()));
@@ -1055,7 +1055,7 @@ void ShadowModule::end_sync()
sub.barrier(GPU_BARRIER_SHADER_STORAGE);
}
{
/** Mark for update all shadow pages touching an updated shadow caster. */
/* Mark for update all shadow pages touching an updated shadow caster. */
PassSimple::Sub &sub = pass.sub("CasterUpdate");
sub.shader_set(inst_.shaders.static_shader_get(SHADOW_TILEMAP_TAG_UPDATE));
sub.bind_ssbo("tilemaps_buf", tilemap_pool.tilemaps_data);
@@ -1099,7 +1099,7 @@ void ShadowModule::end_sync()
PassSimple &pass = tilemap_update_ps_;
pass.init();
{
/** Mark tiles that are redundant in the mipmap chain as unused. */
/* Mark tiles that are redundant in the mipmap chain as unused. */
PassSimple::Sub &sub = pass.sub("MaskLod");
sub.shader_set(inst_.shaders.static_shader_get(SHADOW_PAGE_MASK));
sub.bind_ssbo("tilemaps_buf", tilemap_pool.tilemaps_data);
@@ -1108,7 +1108,7 @@ void ShadowModule::end_sync()
sub.barrier(GPU_BARRIER_SHADER_STORAGE);
}
{
/** Free unused pages & Reclaim cached pages. */
/* Free unused pages & Reclaim cached pages. */
PassSimple::Sub &sub = pass.sub("Free");
sub.shader_set(inst_.shaders.static_shader_get(SHADOW_PAGE_FREE));
sub.bind_ssbo("tilemaps_buf", tilemap_pool.tilemaps_data);
@@ -1117,7 +1117,7 @@ void ShadowModule::end_sync()
sub.bind_ssbo("pages_free_buf", pages_free_data_);
sub.bind_ssbo("pages_cached_buf", pages_cached_data_);
sub.dispatch(int3(1, 1, tilemap_pool.tilemaps_data.size()));
/** Free unused tiles from tile-maps not used by any shadow. */
/* Free unused tiles from tile-maps not used by any shadow. */
if (tilemap_pool.tilemaps_unused.size() > 0) {
sub.bind_ssbo("tilemaps_buf", tilemap_pool.tilemaps_unused);
sub.dispatch(int3(1, 1, tilemap_pool.tilemaps_unused.size()));
@@ -1125,7 +1125,7 @@ void ShadowModule::end_sync()
sub.barrier(GPU_BARRIER_SHADER_STORAGE);
}
{
/** De-fragment the free page heap after cache reuse phase which can leave hole. */
/* De-fragment the free page heap after cache reuse phase which can leave hole. */
PassSimple::Sub &sub = pass.sub("Defrag");
sub.shader_set(inst_.shaders.static_shader_get(SHADOW_PAGE_DEFRAG));
sub.bind_ssbo("pages_infos_buf", pages_infos_data_);
@@ -1138,7 +1138,7 @@ void ShadowModule::end_sync()
sub.barrier(GPU_BARRIER_SHADER_STORAGE);
}
{
/** Assign pages to tiles that have been marked as used but possess no page. */
/* Assign pages to tiles that have been marked as used but possess no page. */
PassSimple::Sub &sub = pass.sub("AllocatePages");
sub.shader_set(inst_.shaders.static_shader_get(SHADOW_PAGE_ALLOCATE));
sub.bind_ssbo("tilemaps_buf", tilemap_pool.tilemaps_data);
@@ -1151,7 +1151,7 @@ void ShadowModule::end_sync()
sub.barrier(GPU_BARRIER_SHADER_STORAGE);
}
{
/** Convert the unordered tiles into a texture used during shading. Creates views. */
/* Convert the unordered tiles into a texture used during shading. Creates views. */
PassSimple::Sub &sub = pass.sub("Finalize");
sub.shader_set(inst_.shaders.static_shader_get(SHADOW_TILEMAP_FINALIZE));
sub.bind_ssbo("tilemaps_buf", tilemap_pool.tilemaps_data);

View File

@@ -49,7 +49,7 @@ class ObjectKey {
ObjectKey(Object *ob, int sub_key = 0)
{
/** Since we use memcmp for comparison,
/* Since we use `memcmp` for comparison,
* we have to ensure the padding bytes are initialized as well. */
memset(this, 0, sizeof(*this));

View File

@@ -158,10 +158,9 @@ void ViewOpsData::state_restore()
/* ROTATE and ZOOM. */
{
/**
* For Rotate this only changes when orbiting from a camera view.
* In this case the `dist` is calculated based on the camera relative to the `ofs`.
*/
/* For Rotate this only changes when orbiting from a camera view.
* In this case the `dist` is calculated based on the camera relative to the `ofs`. */
/* Note this does not remove auto-keys on locked cameras. */
this->rv3d->dist = this->init.dist;
}

View File

@@ -71,12 +71,12 @@ static void APIENTRY debug_callback(GLenum /*source*/,
if (TRIM_NVIDIA_BUFFER_INFO && STRPREFIX(message, "Buffer detailed info") &&
GPU_type_matches(GPU_DEVICE_NVIDIA, GPU_OS_ANY, GPU_DRIVER_OFFICIAL))
{
/** Suppress buffer infos flooding the output. */
/* Suppress buffer infos flooding the output. */
return;
}
if (TRIM_SHADER_STATS_INFO && STRPREFIX(message, "Shader Stats")) {
/** Suppress buffer infos flooding the output. */
/* Suppress buffer infos flooding the output. */
return;
}
@@ -94,7 +94,7 @@ static void APIENTRY debug_callback(GLenum /*source*/,
CLG_Severity clog_severity;
if (GPU_debug_group_match(GPU_DEBUG_SHADER_COMPILATION_GROUP)) {
/** Do not duplicate shader compilation error/warnings. */
/* Do not duplicate shader compilation error/warnings. */
return;
}