From e757c4a3bec8b0e8d198531a28327332af00a9ba Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 12 Dec 2018 12:50:58 +1100 Subject: Cleanup: use colon separator after parameter Helps separate variable names from descriptive text. Was already used in some parts of the code, double space and dashes were used elsewhere. --- source/blender/render/intern/include/shadbuf.h | 6 ++-- source/blender/render/intern/source/pixelshading.c | 12 ++++---- source/blender/render/intern/source/zbuf.c | 32 +++++++++++----------- 3 files changed, 25 insertions(+), 25 deletions(-) (limited to 'source/blender/render') diff --git a/source/blender/render/intern/include/shadbuf.h b/source/blender/render/intern/include/shadbuf.h index 5901d2187dc..5722f37a6a8 100644 --- a/source/blender/render/intern/include/shadbuf.h +++ b/source/blender/render/intern/include/shadbuf.h @@ -37,7 +37,7 @@ /** * Calculates shadowbuffers for a vector of shadow-giving lamps - * \param lar The vector of lamps + * \param lar: The vector of lamps */ void makeshadowbuf(struct Render *re, LampRen *lar); void freeshadowbuf(struct LampRen *lar); @@ -49,8 +49,8 @@ void threaded_makeshadowbufs(struct Render *re); * communication with global variables here. * \return The shadow factors: 1.0 for no shadow, 0.0 for complete * shadow. - * \param shb The shadowbuffer to find the shadow factor in. - * \param inp The inproduct between viewvector and ? + * \param shb: The shadowbuffer to find the shadow factor in. + * \param inp: The inproduct between viewvector and ? * */ float testshadowbuf(struct Render *re, struct ShadBuf *shb, const float rco[3], const float dxco[3], const float dyco[3], float inp, float mat_bias); diff --git a/source/blender/render/intern/source/pixelshading.c b/source/blender/render/intern/source/pixelshading.c index 7f202629ce4..41d679c0b58 100644 --- a/source/blender/render/intern/source/pixelshading.c +++ b/source/blender/render/intern/source/pixelshading.c @@ -243,7 +243,7 @@ static void render_lighting_halo(HaloRen *har, float col_r[3]) /** * Converts a halo z-buffer value to distance from the camera's near plane - * \param z The z-buffer value to convert + * \param z: The z-buffer value to convert * \return a distance from the camera's near plane in blender units */ static float haloZtoDist(int z) @@ -262,13 +262,13 @@ static float haloZtoDist(int z) } /** - * \param col (float[4]) Store the rgb color here (with alpha) + * \param col: (float[4]) Store the rgb color here (with alpha) * The alpha is used to blend the color to the background * color_new = (1-alpha)*color_background + color - * \param zz The current zbuffer value at the place of this pixel - * \param dist Distance of the pixel from the center of the halo squared. Given in pixels - * \param xn The x coordinate of the pixel relaticve to the center of the halo. given in pixels - * \param yn The y coordinate of the pixel relaticve to the center of the halo. given in pixels + * \param zz: The current zbuffer value at the place of this pixel + * \param dist: Distance of the pixel from the center of the halo squared. Given in pixels + * \param xn: The x coordinate of the pixel relaticve to the center of the halo. given in pixels + * \param yn: The y coordinate of the pixel relaticve to the center of the halo. given in pixels */ int shadeHaloFloat(HaloRen *har, float col[4], int zz, float dist, float xn, float yn, short flarec) diff --git a/source/blender/render/intern/source/zbuf.c b/source/blender/render/intern/source/zbuf.c index 6c11dee5dde..8c81187df5f 100644 --- a/source/blender/render/intern/source/zbuf.c +++ b/source/blender/render/intern/source/zbuf.c @@ -1037,9 +1037,9 @@ void zbufsinglewire(ZSpan *zspan, int obi, int zvlnr, const float ho1[4], const * This is one of the z buffer fill functions called in zbufclip() and * zbufwireclip(). * - * \param v1 [4 floats, world coordinates] first vertex - * \param v2 [4 floats, world coordinates] second vertex - * \param v3 [4 floats, world coordinates] third vertex + * \param v1: [4 floats, world coordinates] first vertex + * \param v2: [4 floats, world coordinates] second vertex + * \param v3: [4 floats, world coordinates] third vertex */ /* WATCH IT: zbuffillGLinv4 and zbuffillGL4 are identical except for a 2 lines, @@ -1292,9 +1292,9 @@ static void zbuffillGL4(ZSpan *zspan, int obi, int zvlnr, * This is one of the z buffer fill functions called in zbufclip() and * zbufwireclip(). * - * \param v1 [4 floats, world coordinates] first vertex - * \param v2 [4 floats, world coordinates] second vertex - * \param v3 [4 floats, world coordinates] third vertex + * \param v1: [4 floats, world coordinates] first vertex + * \param v2: [4 floats, world coordinates] second vertex + * \param v3: [4 floats, world coordinates] third vertex */ /* now: filling two Z values, the closest and 2nd closest */ @@ -1592,11 +1592,11 @@ void zspan_scanconvert(ZSpan *zspan, void *handle, float *v1, float *v2, float * * Sets lambda: flag, and parametrize the clipping of vertices in * viewspace coordinates. lambda = -1 means no clipping, lambda in [0, 1] means a clipping. * Note: uses globals. - * \param v1 start coordinate s - * \param v2 target coordinate t - * \param b2 - * \param b3 - * \param a index for coordinate (x, y, or z) + * \param v1: start coordinate s + * \param v2: target coordinate t + * \param b2: + * \param b3: + * \param a: index for coordinate (x, y, or z) */ static void clippyra(float *lambda, float *v1, float *v2, int *b2, int *b3, int a, float clipcrop) @@ -1652,11 +1652,11 @@ static void clippyra(float *lambda, float *v1, float *v2, int *b2, int *b3, int * vertex list of this face. * * - * \param v1 start coordinate s - * \param v2 target coordinate t - * \param b1 - * \param b2 - * \param clve vertex vector. + * \param v1: start coordinate s + * \param v2: target coordinate t + * \param b1: + * \param b2: + * \param clve: vertex vector. */ static void makevertpyra(float *vez, float *lambda, float **trias, float *v1, float *v2, int *b1, int *clve) -- cgit v1.2.3