Cleanup: remove extra in trailing asterisk

Comment blocks not conforming to convention.
This commit is contained in:
Campbell Barton 2021-01-20 15:15:38 +11:00
parent 69d30c1543
commit b2a6e2abdb
62 changed files with 95 additions and 127 deletions

View File

@ -43,7 +43,7 @@ class ColorSpaceProcessor;
*
* Data needed by OSL render services, that is global to a rendering session.
* This includes all OSL shaders, name to attribute mapping and texture handles.
* */
*/
struct OSLGlobals {
OSLGlobals()

View File

@ -122,7 +122,7 @@ extern void *(*MEM_calloc_arrayN)(size_t len,
/**
* Allocate a block of memory of size len, with tag name str. The
* name must be a static, because only a pointer to it is stored !
* */
*/
extern void *(*MEM_mallocN)(size_t len, const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT
ATTR_ALLOC_SIZE(1) ATTR_NONNULL(2);
@ -130,7 +130,7 @@ extern void *(*MEM_mallocN)(size_t len, const char *str) /* ATTR_MALLOC */ ATTR_
* Allocate a block of memory of size (len * size), with tag name str,
* aborting in case of integer overflow to prevent vulnerabilities. The
* name must be a static, because only a pointer to it is stored !
* */
*/
extern void *(*MEM_malloc_arrayN)(size_t len,
size_t size,
const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT
@ -139,7 +139,7 @@ extern void *(*MEM_malloc_arrayN)(size_t len,
/**
* Allocate an aligned block of memory of size len, with tag name str. The
* name must be a static, because only a pointer to it is stored !
* */
*/
extern void *(*MEM_mallocN_aligned)(size_t len,
size_t alignment,
const char *str) /* ATTR_MALLOC */ ATTR_WARN_UNUSED_RESULT

View File

@ -23,7 +23,7 @@
* - passing output paths to the visitor?, like render out.
* - passing sequence strips with many images.
* - passing directory paths - visitors don't know which path is a dir or a file.
* */
*/
#include <sys/stat.h>

View File

@ -318,7 +318,7 @@ static eContextResult ctx_data_get(bContext *C, const char *member, bContextData
*
* Values in order of importance
* (0, -1, 1) - Where 1 is highest priority
* */
*/
if (done != 1 && recursion < 1 && C->wm.store) {
C->data.recursion = 1;

View File

@ -2373,7 +2373,7 @@ static void make_bevel_list_3D_minimum_twist(BevList *bl)
* 0,1,2,3,4 --> 1,2,3,4,0
*
* this is why we compare last with second last
* */
*/
float vec_1[3] = {0, 1, 0}, vec_2[3] = {0, 1, 0}, angle, ang_fac, cross_tmp[3];
BevPoint *bevp_first;

View File

@ -233,7 +233,7 @@ static bool calc_curve_deform(
* Now for Neg Up XYZ, the colors are all dark, and ordered clockwise - Campbell
*
* note: moved functions into quat_apply_track/vec_apply_track
* */
*/
copy_qt_qt(quat, new_quat);
copy_v3_v3(cent, co);

View File

@ -1132,7 +1132,7 @@ static void curve_calc_modifiers_post(Depsgraph *depsgraph,
*
* The right solution would be to COW the Curve data block at the input of the modifier
* stack just like what the mesh modifier does.
* */
*/
modified = BKE_mesh_new_nomain_from_curve_displist(ob, dispbase);
}

View File

@ -140,7 +140,7 @@ static void compute_eigenstuff(struct OceanResult *ocr, float jxx, float jzz, fl
* instead of Complex.h
* in fftw.h "fftw_complex" typedefed as double[2]
* below you can see functions are needed to work with such complex numbers.
* */
*/
static void init_complex(fftw_complex cmpl, float real, float image)
{
cmpl[0] = real;

View File

@ -1167,8 +1167,7 @@ bool BKE_unit_replace_string(
/* Replace # with add sign when there is no operator between it and the next number.
*
* "1*1# 3*100# * 3" -> "1*1+ 3*100 * 3"
*
* */
*/
{
char *str_found = str;
const char *ch = str;

View File

@ -20,7 +20,7 @@
/** \file
* \ingroup bli
* \brief File and directory operations.
* */
*/
#pragma once

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
#pragma once

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
#pragma once

View File

@ -12,8 +12,7 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* */
*/
#pragma once

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
#pragma once

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
#pragma once

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
#pragma once

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
#pragma once

View File

@ -17,7 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
* */
*/
#pragma once

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
#pragma once

View File

@ -15,7 +15,7 @@
*
* The Original Code is Copyright (C) 2015 by Blender Foundation
* All rights reserved.
* */
*/
#pragma once

View File

@ -15,7 +15,7 @@
*
* The Original Code is Copyright (C) 2015 by Blender Foundation
* All rights reserved.
* */
*/
#pragma once

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
#pragma once

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
/** \file
* \ingroup bli

View File

@ -414,8 +414,7 @@ void BLI_box_pack_2d(BoxPack *boxarray, const uint len, float *r_tot_x, float *r
/* This vert has a free quadrant
* Test if we can place the box here
* vert->free & quad_flags[j] - Checks
* */
* `vert->free & quad_flags[j]` - Checks. */
for (j = 0; (j < 4) && isect; j++) {
if (vert->free & quad_flag(j)) {

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
/** \file
* \ingroup bli

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
/** \file
* \ingroup bli

View File

@ -12,8 +12,7 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* */
*/
/** \file
* \ingroup bli

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
/** \file
* \ingroup bli

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
/** \file
* \ingroup bli

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
/** \file
* \ingroup bli

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
/** \file
* \ingroup bli
@ -3887,7 +3886,7 @@ void interp_weights_quad_v3(float w[4],
* - 0 if the point is outside of triangle.
* - 1 if the point is inside triangle.
* - 2 if it's on the edge.
* */
*/
int barycentric_inside_triangle_v2(const float w[3])
{
if (IN_RANGE(w[0], 0.0f, 1.0f) && IN_RANGE(w[1], 0.0f, 1.0f) && IN_RANGE(w[2], 0.0f, 1.0f)) {

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
/** \file
* \ingroup bli

View File

@ -15,7 +15,7 @@
*
* The Original Code is Copyright (C) 2015 by Blender Foundation.
* All rights reserved.
* */
*/
/** \file
* \ingroup bli

View File

@ -15,7 +15,7 @@
*
* The Original Code is Copyright (C) 2015 by Blender Foundation.
* All rights reserved.
* */
*/
/** \file
* \ingroup bli

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
/** \file
* \ingroup bli

View File

@ -17,8 +17,7 @@
* All rights reserved.
*
* The Original Code is: some of this file.
*
* */
*/
/** \file
* \ingroup bli

View File

@ -1650,7 +1650,7 @@ bool BLI_path_filename_ensure(char *filepath, size_t maxlen, const char *filenam
* - Wont create any directories.
* - Doesn't use CWD, or deal with relative paths.
* - Only fill's in \a dir and \a file when they are non NULL.
* */
*/
void BLI_split_dirfile(
const char *string, char *dir, char *file, const size_t dirlen, const size_t filelen)
{

View File

@ -289,9 +289,8 @@ void BLI_threadpool_clear(ListBase *threadbase)
void BLI_threadpool_end(ListBase *threadbase)
{
/* only needed if there's actually some stuff to end
* this way we don't end up decrementing thread_levels on an empty threadbase
* */
/* Only needed if there's actually some stuff to end
* this way we don't end up decrementing thread_levels on an empty `threadbase`. */
if (threadbase == nullptr || BLI_listbase_is_empty(threadbase)) {
return;
}

View File

@ -499,7 +499,7 @@ void do_versions_after_linking_290(Main *bmain, ReportList *UNUSED(reports))
/**
* Make sure Emission Alpha fcurve and drivers is properly mapped after the Emission Strength
* got introduced.
* */
*/
/**
* Effectively we are replacing the (animation of) node socket input 18 with 19.
@ -510,7 +510,7 @@ void do_versions_after_linking_290(Main *bmain, ReportList *UNUSED(reports))
*
* The for loop for the input ids is at the top level otherwise we lose the animation
* keyframe data.
* */
*/
for (int input_id = 21; input_id >= 18; input_id--) {
FOREACH_NODETREE_BEGIN (bmain, ntree, id) {
if (ntree->type == NTREE_SHADER) {

View File

@ -294,8 +294,7 @@ static void bm_decim_build_edge_cost_single(BMEdge *e,
/* subtract existing cost to further differentiate edges from one another
*
* keep topology cost below 0.0 so their values don't interfere with quadric cost,
* (and they get handled first).
* */
* (and they get handled first). */
if (vweights == NULL) {
cost = bm_decim_build_edge_cost_single_squared__topology(e) - cost;
}

View File

@ -306,8 +306,7 @@ static EditBone *get_named_editbone(ListBase *edbo, const char *name)
return NULL;
}
/* Call this before doing any duplications
* */
/* Call this before doing any duplications. */
void preEditBoneDuplicate(ListBase *editbones)
{
/* clear temp */

View File

@ -98,8 +98,7 @@ enum TfmMode {
/* Standalone call to get the transformation center corresponding to the current situation
* returns 1 if successful, 0 otherwise (usually means there's no selection)
* (if 0 is returns, *vec is unmodified)
* */
* (if false is returns, `cent3d` is unmodified). */
bool calculateTransformCenter(struct bContext *C,
int centerMode,
float cent3d[3],

View File

@ -664,8 +664,7 @@ bool UI_popup_block_name_exists(const struct bScreen *screen, const char *name);
* Begin/Define Buttons/End/Draw is the typical order in which these
* function should be called, though for popup blocks Draw is left out.
* Freeing blocks is done by the screen/ module automatically.
*
* */
*/
uiBlock *UI_block_begin(const struct bContext *C,
struct ARegion *region,

View File

@ -1279,12 +1279,10 @@ static bool ui_but_event_property_operator_string(const bContext *C,
char *buf,
const size_t buf_len)
{
/* context toggle operator names to check... */
/* Context toggle operator names to check. */
/* This function could use a refactor to generalize button type to operator relationship
* as well as which operators use properties.
* - Campbell
* */
* as well as which operators use properties. - Campbell */
const char *ctx_toggle_opnames[] = {
"WM_OT_context_toggle",
"WM_OT_context_toggle_enum",

View File

@ -3750,8 +3750,7 @@ static void brush_puff(PEData *data, int point_index, float mouse_distance)
}
}
else {
/* compute position as if hair was standing up straight.
* */
/* Compute position as if hair was standing up straight. */
float length;
copy_v3_v3(co_prev, co);
copy_v3_v3(co, key->co);

View File

@ -57,11 +57,12 @@ static void immDrawPixelsTexSetupAttributes(IMMDrawPixelsTexState *state)
vert_format, "texCoord", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
}
/* To be used before calling immDrawPixelsTex
* Default shader is GPU_SHADER_2D_IMAGE_COLOR
* You can still set uniforms with :
* GPU_shader_uniform_int(shader, GPU_shader_get_uniform(shader, "name"), 0);
* */
/**
* To be used before calling #immDrawPixelsTex
* Default shader is #GPU_SHADER_2D_IMAGE_COLOR
* You can still set uniforms with:
* `GPU_shader_uniform_int(shader, GPU_shader_get_uniform(shader, "name"), 0);`
*/
IMMDrawPixelsTexState immDrawPixelsTexSetup(int builtin)
{
IMMDrawPixelsTexState state;
@ -77,10 +78,11 @@ IMMDrawPixelsTexState immDrawPixelsTexSetup(int builtin)
return state;
}
/* Use the currently bound shader.
/**
* Use the currently bound shader.
*
* Use immDrawPixelsTexSetup to bind the shader you
* want before calling immDrawPixelsTex.
* Use #immDrawPixelsTexSetup to bind the shader you
* want before calling #immDrawPixelsTex.
*
* If using a special shader double check it uses the same
* attributes "pos" "texCoord" and uniform "image".
@ -89,7 +91,7 @@ IMMDrawPixelsTexState immDrawPixelsTexSetup(int builtin)
*
* Be also aware that this function unbinds the shader when
* it's finished.
* */
*/
void immDrawPixelsTexScaled_clipping(IMMDrawPixelsTexState *state,
float x,
float y,

View File

@ -2415,9 +2415,10 @@ static bool IsectPT2Df_limit(
(area_tri_v2(v1, v2, v3))) < limit;
}
/* Clip the face by a bucket and set the uv-space bucket_bounds_uv
/**
* Clip the face by a bucket and set the uv-space bucket_bounds_uv
* so we have the clipped UV's to do pixel intersection tests with
* */
*/
static int float_z_sort_flip(const void *p1, const void *p2)
{
return (((float *)p1)[2] < ((float *)p2)[2] ? 1 : -1);

View File

@ -62,14 +62,15 @@
#include "node_intern.h" /* own include */
/* Function to detect if there is a visible view3d that uses workbench in texture mode.
/**
* Function to detect if there is a visible view3d that uses workbench in texture mode.
* This function is for fixing T76970 for Blender 2.83. The actual fix should add a mechanism in
* the depsgraph that can be used by the draw engines to check if they need to be redrawn.
*
* We don't want to add these risky changes this close before releasing 2.83 without good testing
* hence this workaround. There are still cases were too many updates happen. For example when you
* have both a Cycles and workbench with textures viewport.
* */
*/
static bool has_workbench_in_texture_color(const wmWindowManager *wm,
const Scene *scene,
const Object *ob)

View File

@ -314,7 +314,7 @@ static void outliner_object_set_flag_recursive_fn(bContext *C,
/**
* Object properties.
* */
*/
static void outliner__object_set_flag_recursive_fn(bContext *C, void *poin, void *poin2)
{
Object *ob = poin;
@ -324,7 +324,7 @@ static void outliner__object_set_flag_recursive_fn(bContext *C, void *poin, void
/**
* Base properties.
* */
*/
static void outliner__base_set_flag_recursive_fn(bContext *C, void *poin, void *poin2)
{
Base *base = poin;

View File

@ -1547,7 +1547,7 @@ static bool outliner_is_co_within_active_mode_column(bContext *C,
* Action to run when clicking in the outliner,
*
* May expend/collapse branches or activate items.
* */
*/
static int outliner_item_do_activate_from_cursor(bContext *C,
const int mval[2],
const bool extend,

View File

@ -2494,8 +2494,7 @@ static int view3d_select_exec(bContext *C, wmOperator *op)
}
/* Pass-through allows tweaks
* FINISHED to signal one operator worked
* */
* FINISHED to signal one operator worked. */
if (retval) {
WM_event_add_notifier(C, NC_SCENE | ND_OB_SELECT, scene);
return OPERATOR_PASS_THROUGH | OPERATOR_FINISHED;

View File

@ -1466,7 +1466,7 @@ static void mesh_customdatacorrect_apply_vert(struct TransCustomDataLayer *tcld,
*
* Interpolate from every other loop (not ideal)
* However values will only be taken from loops which overlap other mdisps.
* */
*/
const bool update_loop_mdisps = is_moved && do_loop_mdisps && (tcld->cd_loop_mdisp_offset != -1);
if (update_loop_mdisps) {
float(*faces_center)[3] = BLI_array_alloca(faces_center, l_num);

View File

@ -200,7 +200,7 @@ void GPU_vertformat_alias_add(GPUVertFormat *format, const char *alias)
*
* WARNING: this function creates a lot of aliases/attributes, make sure to keep the attribute
* name short to avoid overflowing the name-buffer.
* */
*/
void GPU_vertformat_multiload_enable(GPUVertFormat *format, int load_count)
{
/* Sanity check. Maximum can be upgraded if needed. */

View File

@ -1878,7 +1878,7 @@ static void execute_scene(struct Depsgraph *depsgraph,
/*---------------------------------------------------
* plugin interface
* */
*/
void itasc_initialize_tree(struct Depsgraph *depsgraph,
struct Scene *scene,
Object *ob,

View File

@ -425,7 +425,7 @@ static int check_pixel_assigned(
*
* When a mask is given, only effect pixels with a mask value of 1,
* defined as #BAKE_MASK_MARGIN in rendercore.c
* */
*/
void IMB_filter_extend(struct ImBuf *ibuf, char *mask, int filter)
{
const int width = ibuf->x;

View File

@ -112,7 +112,7 @@ static OArchive *create_archive(std::ofstream *abc_ostream,
*
* If 'time_relative' is true, samples are returned as time (in seconds) from params.frame_start.
* If 'time_relative' is false, samples are returned as fractional frames from 0.
* */
*/
static void get_shutter_samples(double scene_fps,
const AlembicExportParams &params,
int nr_of_samples,

View File

@ -254,7 +254,7 @@ typedef struct IDOverrideLibrary {
/**
* ID is the first thing included in all serializable types. It
* provides a common handle to place all data in double-linked lists.
* */
*/
/* 2 characters for ID code and 64 for actual name */
#define MAX_ID_NAME 66

View File

@ -397,13 +397,11 @@ static int add_type(const char *str, int size)
}
/**
*
* Because of the weird way of tokenizing, we have to 'cast' function
* pointers to ... (*f)(), whatever the original signature. In fact,
* we add name and type at the same time... There are two special
* cases, unfortunately. These are explicitly checked.
*
* */
*/
static int add_name(const char *str)
{
char buf[255]; /* stupid limit, change it :) */
@ -479,17 +477,16 @@ static int add_name(const char *str)
}
/*
* Put )(void) at the end? Maybe )(). Should check this with
* old sdna. Actually, sometimes )(), sometimes )(void...)
* Put `)(void)` at the end? Maybe `)()`. Should check this with
* old `sdna`. Actually, sometimes `)()`, sometimes `)(void...)`
* Alas.. such is the nature of brain-damage :(
*
* Sorted it out: always do )(), except for headdraw and
* windraw, part of ScrArea. This is important, because some
* Sorted it out: always do )(), except for `headdraw` and
* `windraw`, part of #ScrArea. This is important, because some
* linkers will treat different fp's differently when called
* !!! This has to do with interference in byte-alignment and
* the way args are pushed on the stack.
*
* */
* the way arguments are pushed on the stack.
*/
buf[i] = 0;
DEBUG_PRINTF(3, "Name before chomping: %s\n", buf);
if ((strncmp(buf, "(*headdraw", 10) == 0) || (strncmp(buf, "(*windraw", 9) == 0)) {

View File

@ -486,9 +486,7 @@ static Mesh *modifyMesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *
/*
* Normal Calculation (for face flipping)
* Sort edge verts for correct face flipping
* NOT REALLY NEEDED but face flipping is nice.
*
* */
* NOT REALLY NEEDED but face flipping is nice. */
/* Notice!
*

View File

@ -8737,15 +8737,17 @@ void pyrna_free_types(void)
RNA_PROP_END;
}
/* Note! MemLeak XXX
/**
* \warning memory leak!
*
* There is currently a bug where moving the registration of a Python class does
* not properly manage reference-counts from the Python class. As the srna owns
* not properly manage reference-counts from the Python class. As the `srna` owns
* the Python class this should not be so tricky, but changing the references as
* you'd expect when changing ownership crashes blender on exit so I had to comment out
* the decref. This is not so bad because the leak only happens when re-registering (hold F8)
* the #Py_DECREF. This is not so bad because the leak only happens when re-registering
* (continuously running `SCRIPT_OT_reload`).
* - Should still be fixed - Campbell
* */
*/
PyDoc_STRVAR(pyrna_register_class_doc,
".. method:: register_class(cls)\n"
"\n"

View File

@ -246,8 +246,7 @@ void WM_cursor_wait(bool val)
void WM_cursor_grab_enable(wmWindow *win, int wrap, bool hide, int bounds[4])
{
/* Only grab cursor when not running debug.
* It helps not to get a stuck WM when hitting a breakpoint
* */
* It helps not to get a stuck WM when hitting a break-point. */
GHOST_TGrabCursorMode mode = GHOST_kGrabNormal;
GHOST_TAxisFlag mode_axis = GHOST_kAxisX | GHOST_kGrabAxisY;

View File

@ -424,9 +424,8 @@ static int wm_macro_modal(bContext *C, wmOperator *op, const wmEvent *event)
wm_event_free_handler(&handler->head);
}
/* if operator is blocking, grab cursor
* This may end up grabbing twice, but we don't care.
* */
/* If operator is blocking, grab cursor.
* This may end up grabbing twice, but we don't care. */
if (op->opm->type->flag & OPTYPE_BLOCKING) {
int bounds[4] = {-1, -1, -1, -1};
int wrap = WM_CURSOR_WRAP_NONE;