Cleanup: comment indentation & spelling
authorCampbell Barton <ideasman42@gmail.com>
Sun, 10 Feb 2019 23:51:25 +0000 (10:51 +1100)
committerCampbell Barton <ideasman42@gmail.com>
Sun, 10 Feb 2019 23:51:25 +0000 (10:51 +1100)
30 files changed:
source/blender/blenkernel/intern/deform.c
source/blender/blenkernel/intern/gpencil.c
source/blender/blenkernel/intern/library_remap.c
source/blender/blenlib/intern/BLI_kdopbvh.c
source/blender/blenlib/intern/math_geom.c
source/blender/blenlib/intern/path_util.c
source/blender/blenlib/intern/threads.c
source/blender/bmesh/intern/bmesh_query.c
source/blender/bmesh/tools/bmesh_bevel.c
source/blender/collada/AnimationExporter.cpp
source/blender/collada/BCAnimationCurve.cpp
source/blender/collada/BCAnimationSampler.cpp
source/blender/collada/BCAnimationSampler.h
source/blender/collada/collada_utils.cpp
source/blender/compositor/operations/COM_TextureOperation.cpp
source/blender/draw/engines/eevee/eevee_bloom.c
source/blender/draw/engines/gpencil/gpencil_engine.c
source/blender/draw/intern/draw_cache.c
source/blender/editors/armature/pose_slide.c
source/blender/editors/curve/editcurve.c
source/blender/editors/gpencil/gpencil_brush.c
source/blender/editors/gpencil/gpencil_utils.c
source/blender/editors/metaball/mball_edit.c
source/blender/editors/object/object_modifier.c
source/blender/editors/space_outliner/outliner_collections.c
source/blender/editors/space_outliner/outliner_dragdrop.c
source/blender/editors/transform/transform.c
source/blender/gpu/GPU_shader.h
source/blender/makesrna/intern/rna_object.c
source/blender/python/gpu/gpu_py_batch.c

index a6c5ddf..4eb47c4 100644 (file)
@@ -1187,8 +1187,8 @@ bool data_transfer_layersmapping_vgroups(
                        idx_src = fromlayers;
                        if (idx_src >= BLI_listbase_count(&ob_src->defbase)) {
                                /* This can happen when vgroups are removed from source object...
-                                * Remapping would be really tricky here, we'd need to go over all objects in Main everytime we delete
-                                * a vgroup... for now, simpler and safer to abort. */
+                                * Remapping would be really tricky here, we'd need to go over all objects in
+                                * Main every time we delete a vgroup... for now, simpler and safer to abort. */
                                return false;
                        }
                }
index 1b3dfea..d2ca18e 100644 (file)
@@ -1371,7 +1371,8 @@ bool BKE_gpencil_smooth_stroke_thickness(bGPDstroke *gps, int point_index, float
 }
 
 /**
-* Apply smooth for UV rotation to stroke point (use pressure) */
+ * Apply smooth for UV rotation to stroke point (use pressure).
+ */
 bool BKE_gpencil_smooth_stroke_uv(bGPDstroke *gps, int point_index, float influence)
 {
        bGPDspoint *ptb = &gps->points[point_index];
index 2b67f0d..efd9063 100644 (file)
@@ -416,7 +416,7 @@ ATTR_NONNULL(1) static void libblock_remap_data(
        else {
                i = set_listbasepointers(bmain, lb_array);
 
-               /* Note that this is a very 'bruteforce' approach, maybe we could use some depsgraph to only process
+               /* Note that this is a very 'brute force' approach, maybe we could use some depsgraph to only process
                 * objects actually using given old_id... sounds rather unlikely currently, though, so this will do for now. */
 
                while (i--) {
@@ -966,7 +966,7 @@ static void id_delete(Main *bmain, const bool do_tagged_deletion)
                 * This means that we won't have to loop over all deleted IDs to remove usages
                 * of other deleted IDs.
                 * This gives tremendous speed-up when deleting a large amount of IDs from a Main
-                * countaining thousands of those.
+                * containing thousands of those.
                 * This also means that we have to be very careful here, as we by-pass many 'common'
                 * processing, hence risking to 'corrupt' at least user counts, if not IDs themselves. */
                bool keep_looping = true;
@@ -1081,7 +1081,7 @@ void BKE_id_delete(Main *bmain, void *idv)
 /**
  * Properly delete all IDs tagged with \a LIB_TAG_DOIT, in given \a bmain database.
  *
- * This is more efficient than calling #BKE_id_delete repitively on a large set of IDs
+ * This is more efficient than calling #BKE_id_delete repetitively on a large set of IDs
  * (several times faster when deleting most of the IDs at once)...
  *
  * \warning Considered experimental for now, seems to be working OK but this is
index 3d73e95..8f92f00 100644 (file)
@@ -1793,7 +1793,7 @@ int BLI_bvhtree_range_query(
 
 /* -------------------------------------------------------------------- */
 /** \name BLI_bvhtree_nearest_projected
-* \{ */
+ * \{ */
 
 static void bvhtree_nearest_projected_dfs_recursive(
         BVHNearestProjectedData *__restrict data, const BVHNode *node)
index f661ac0..0b861a1 100644 (file)
@@ -774,7 +774,7 @@ float dist_squared_ray_to_aabb_v3_simple(
 
 /* -------------------------------------------------------------------- */
 /** \name dist_squared_to_projected_aabb and helpers
-* \{ */
+ * \{ */
 
 /**
  * \param projmat: Projection Matrix (usually perspective
index a41f524..a80b4ea 100644 (file)
@@ -1259,8 +1259,8 @@ void BLI_setenv_if_new(const char *env, const char *val)
 }
 
 /**
-* get an env var, result has to be used immediately
-*/
+ * Get an env var, result has to be used immediately.
+ */
 const char *BLI_getenv(const char *env)
 {
 #ifdef _MSC_VER
index 20e332b..8a9e9f1 100644 (file)
@@ -857,13 +857,13 @@ static bool check_is_threadripper2_alike_topology(void)
        }
        if (strstr(cpu_brand, "Threadripper")) {
                /* NOTE: We consinder all Threadrippers having similar topology to
-               * the second one. This is because we are trying to utilize NUMA node
-               * 0 as much as possible. This node does exist on earlier versions of
-               * threadripper and setting affinity to it should not have negative
-               * effect.
-               * This allows us to avoid per-model check, making the code more
-               * reliable for the CPUs which are not yet released.
-               */
+                * the second one. This is because we are trying to utilize NUMA node
+                * 0 as much as possible. This node does exist on earlier versions of
+                * threadripper and setting affinity to it should not have negative
+                * effect.
+                * This allows us to avoid per-model check, making the code more
+                * reliable for the CPUs which are not yet released.
+                */
                if (strstr(cpu_brand, "2990WX") || strstr(cpu_brand, "2950X")) {
                        is_threadripper2 = true;
                }
index 2409196..b1ac136 100644 (file)
@@ -1671,13 +1671,13 @@ float BM_edge_calc_face_angle(const BMEdge *e)
 }
 
 /**
-* \brief BMESH EDGE/FACE ANGLE
-*
-* Calculates the angle between two faces in world space.
-* Assumes the face normals are correct.
-*
-* \return angle in radians
-*/
+ * \brief BMESH EDGE/FACE ANGLE
+ *
+ * Calculates the angle between two faces in world space.
+ * Assumes the face normals are correct.
+ *
+ * \return angle in radians
+ */
 float BM_edge_calc_face_angle_with_imat3_ex(const BMEdge *e, const float imat3[3][3], const float fallback)
 {
        if (BM_edge_is_manifold(e)) {
index 4d96f49..cb1bbc0 100644 (file)
@@ -1348,8 +1348,8 @@ static bool make_unit_square_map(
        add_v3_v3v3(vd, vo, vddir);
 
        /* The cols of m are: {vmid - va, vmid - vb, vmid + vd - va -vb, va + vb - vmid;
-               * blender transform matrices are stored such that m[i][*] is ith column;
-               * the last elements of each col remain as they are in unity matrix */
+        * blender transform matrices are stored such that m[i][*] is ith column;
+        * the last elements of each col remain as they are in unity matrix. */
        sub_v3_v3v3(&r_mat[0][0], vmid, va);
        r_mat[0][3] = 0.0f;
        sub_v3_v3v3(&r_mat[1][0], vmid, vb);
index f8644f2..1796718 100644 (file)
@@ -258,14 +258,14 @@ void AnimationExporter::export_bone_animations_recursive(Object *ob, Bone *bone,
                export_bone_animations_recursive(ob, child, sampler);
 }
 
-/*
-* In some special cases the exported Curve needs to be replaced
-* by a modified curve (for collada purposes)
-* This method checks if a conversion is necessary and if applicable
-* returns a pointer to the modified BCAnimationCurve.
-* IMPORTANT: the modified curve must be deleted by the caller when no longer needed
-* if no conversion is needed this method returns a NULL;
-*/
+/**
+ * In some special cases the exported Curve needs to be replaced
+ * by a modified curve (for collada purposes)
+ * This method checks if a conversion is necessary and if applicable
+ * returns a pointer to the modified BCAnimationCurve.
+ * IMPORTANT: the modified curve must be deleted by the caller when no longer needed
+ * if no conversion is needed this method returns a NULL;
+ */
 BCAnimationCurve *AnimationExporter::get_modified_export_curve(Object *ob, BCAnimationCurve &curve, BCAnimationCurveMap &curves)
 {
        std::string channel_target = curve.get_channel_target();
index 144a329..180e351 100644 (file)
@@ -398,9 +398,9 @@ bool BCAnimationCurve::add_value_from_matrix(const BCSample &sample, const int f
        int array_index = curve_key.get_array_index();
 
        /* transformation curves are feeded directly from the transformation matrix
-       * to resolve parent inverse matrix issues with object hierarchies.
-       * Maybe this can be unified with the
-       */
+        * to resolve parent inverse matrix issues with object hierarchies.
+        * Maybe this can be unified with the
+        */
        const std::string channel_target = get_channel_target();
        float val = 0;
        /* Pick the value from the sample according to the definition of the FCurve */
index c22a5d5..10a5bb8 100644 (file)
@@ -394,11 +394,11 @@ void BCAnimationSampler::generate_transforms(Object *ob, Bone *bone, BCAnimation
                generate_transforms(ob, child, curves);
 }
 
-/*
-* Collect all keyframes from all animation curves related to the object
-* The bc_get... functions check for NULL and correct object type
-* The add_keyframes_from() function checks for NULL
-*/
+/**
+ * Collect all keyframes from all animation curves related to the object
+ * The bc_get... functions check for NULL and correct object type
+ * The add_keyframes_from() function checks for NULL
+ */
 void BCAnimationSampler::initialize_keyframes(BCFrameSet &frameset, Object *ob)
 {
        frameset.clear();
index e00d287..19ccb88 100644 (file)
@@ -108,28 +108,28 @@ typedef std::map<int, BCSampleFrame> BCSampleFrameMap;
 class BCSampleFrameContainer {
 
        /*
-       * The BCSampleFrameContainer stores a map of BCSampleFrame objects
-       * with the timeline frame as key.
-       *
-       * Some details on the purpose:
-       * An Animation is made of multiple FCurves where each FCurve can
-       * have multiple keyframes. When we want to export the animation we
-       * also can decide whether we want to export the keyframes or a set
-       * of sample frames at equidistant locations (sample period).
-       * In any case we must resample first need to resample it fully
-       * to resolve things like:
-       *
-       * - animations by constraints
-       * - animations by drivers
-       *
-       * For this purpose we need to step through the entire animation and
-       * then sample each frame that contains at least one keyFrame or
-       * sampleFrame. Then for each frame we have to store the transform
-       * information for all exported objects in a BCSampleframe
-       *
-       * The entire set of BCSampleframes is finally collected into
-       * a BCSampleframneContainer
-       */
+        * The BCSampleFrameContainer stores a map of BCSampleFrame objects
+        * with the timeline frame as key.
+        *
+        * Some details on the purpose:
+        * An Animation is made of multiple FCurves where each FCurve can
+        * have multiple keyframes. When we want to export the animation we
+        * also can decide whether we want to export the keyframes or a set
+        * of sample frames at equidistant locations (sample period).
+        * In any case we must resample first need to resample it fully
+        * to resolve things like:
+        *
+        * - animations by constraints
+        * - animations by drivers
+        *
+        * For this purpose we need to step through the entire animation and
+        * then sample each frame that contains at least one keyFrame or
+        * sampleFrame. Then for each frame we have to store the transform
+        * information for all exported objects in a BCSampleframe
+        *
+        * The entire set of BCSampleframes is finally collected into
+        * a BCSampleframneContainer
+        */
 
 private:
        BCSampleFrameMap sample_frames;
index cf9a800..daf001b 100644 (file)
@@ -310,12 +310,12 @@ Object *bc_get_assigned_armature(Object *ob)
        return ob_arm;
 }
 
-/*
-* Returns the highest selected ancestor
-* returns NULL if no ancestor is selected
-* IMPORTANT: This function expects that all exported objects have set:
-* ob->id.tag & LIB_TAG_DOIT
-*/
+/**
+ * Returns the highest selected ancestor
+ * returns NULL if no ancestor is selected
+ * IMPORTANT: This function expects that all exported objects have set:
+ * ob->id.tag & LIB_TAG_DOIT
+ */
 Object *bc_get_highest_selected_ancestor_or_self(LinkNode *export_set, Object *ob)
 
 {
@@ -969,9 +969,8 @@ bool bc_bone_matrix_local_get(Object *ob, Bone *bone, Matrix &mat, bool for_open
                copy_m4_m4(mat, pchan->pose_mat);
 
        /* OPEN_SIM_COMPATIBILITY
-       * AFAIK animation to second life is via BVH, but no
-       * reason to not have the collada-animation be correct
-       */
+        * AFAIK animation to second life is via BVH, but no
+        * reason to not have the collada-animation be correct */
        if (for_opensim) {
                float temp[4][4];
                copy_m4_m4(temp, bone->arm_mat);
index 3cbc016..7f95843 100644 (file)
@@ -112,7 +112,7 @@ void TextureBaseOperation::executePixelSampled(float output[4], float x, float y
 
        /* When no interpolation/filtering happens in multitex() foce nearest interpolation.
         * We do it here because (a) we can't easily say multitex() that we want nearest
-        * interpolaiton and (b) in such configuration multitex() sinply floor's the value
+        * interpolation and (b) in such configuration multitex() sinply floor's the value
         * which often produces artifacts.
         */
        if (m_texture != NULL && (m_texture->imaflag & TEX_INTERPOL) == 0) {
index 2c3baf0..0c135ce 100644 (file)
@@ -218,7 +218,7 @@ void EEVEE_bloom_cache_init(EEVEE_ViewLayerData *UNUSED(sldata), EEVEE_Data *ved
                 *   and do an upsample blur for each new accumulated layer.
                 * - Finally add accumulation buffer onto the source color buffer.
                 *
-                *  [1/1] is original copy resolution (can be half or quater res for performance)
+                *  [1/1] is original copy resolution (can be half or quarter res for performance)
                 *
                 *                                [DOWNSAMPLE CHAIN]                      [UPSAMPLE CHAIN]
                 *
index eff8d07..3c3f62b 100644 (file)
@@ -584,8 +584,7 @@ void GPENCIL_cache_populate(void *vedata, Object *ob)
                }
 
                /* draw current painting strokes
-               * (only if region is equal to originated paint region)
-               */
+                * (only if region is equal to originated paint region) */
                if ((draw_ctx->obact == ob) &&
                    ((gpd->runtime.ar == NULL) || (gpd->runtime.ar == draw_ctx->ar)))
                {
index b006c53..bbabcd8 100644 (file)
@@ -658,7 +658,7 @@ GPUBatch *DRW_cache_gpencil_axes_get(void)
 
 /* -------------------------------------------------------------------- */
 /** \name Common Object API
-* \{ */
+ * \{ */
 
 GPUBatch *DRW_cache_object_all_edges_get(Object *ob)
 {
index ec2ce69..a7b599d 100644 (file)
@@ -206,8 +206,7 @@ static int pose_slide_init(bContext *C, wmOperator *op, ePoseSlide_Modes mode)
        pso->axislock = RNA_enum_get(op->ptr, "axis_lock");
 
        /* for each Pose-Channel which gets affected, get the F-Curves for that channel
-       * and set the relevant transform flags...
-       */
+        * and set the relevant transform flags... */
        poseAnim_mapping_get(C, &pso->pfLinks);
 
        Object **objects = BKE_view_layer_array_from_objects_in_mode_unique_data(CTX_data_view_layer(C),
index 1821d39..23dc165 100644 (file)
@@ -4341,8 +4341,8 @@ static int make_segment_exec(bContext *C, wmOperator *op)
                                                        nu1 = nu;
 
                                                        /* Just in case both of first/last CV are selected check
-                                                       * whether we really need to switch the direction.
-                                                       */
+                                                        * whether we really need to switch the direction.
+                                                        */
                                                        if (!BEZT_ISSEL_ANY_HIDDENHANDLES(v3d, nu1->bezt)) {
                                                                BKE_nurb_direction_switch(nu1);
                                                                keyData_switchDirectionNurb(cu, nu1);
@@ -4358,8 +4358,8 @@ static int make_segment_exec(bContext *C, wmOperator *op)
                                                        nu2 = nu;
 
                                                        /* Just in case both of first/last CV are selected check
-                                                       * whether we really need to switch the direction.
-                                                       */
+                                                        * whether we really need to switch the direction.
+                                                        */
                                                        if (!BEZT_ISSEL_ANY_HIDDENHANDLES(v3d, &(nu->bezt[nu2->pntsu - 1]))) {
                                                                BKE_nurb_direction_switch(nu2);
                                                                keyData_switchDirectionNurb(cu, nu2);
@@ -4369,9 +4369,9 @@ static int make_segment_exec(bContext *C, wmOperator *op)
                                }
                                else if (nu->pntsv == 1) {
                                        /* Same logic as above: if first point is selected spline is
-                                       * preferred for nu1, if last point is selected spline is
-                                       * preferred for u2u.
-                                       */
+                                        * preferred for nu1, if last point is selected spline is
+                                        * preferred for u2u.
+                                        */
 
                                        bp = nu->bp;
                                        if (bp[nu->pntsu - 1].f1 & SELECT) {
index c702036..a409087 100644 (file)
@@ -1244,9 +1244,8 @@ static bool gpsculpt_brush_init(bContext *C, wmOperator *op)
        gso->is_multiframe = (bool)GPENCIL_MULTIEDIT_SESSIONS_ON(gso->gpd);
        gso->use_multiframe_falloff = (ts->gp_sculpt.flag & GP_SCULPT_SETT_FLAG_FRAME_FALLOFF) != 0;
 
-       /* init multiedit falloff curve data before doing anything,
-        * so we won't have to do it again later
-        */
+       /* Init multi-edit falloff curve data before doing anything,
+        * so we won't have to do it again later. */
        if (gso->is_multiframe) {
                curvemapping_initialize(ts->gp_sculpt.cur_falloff);
        }
index 210d234..0fe1412 100644 (file)
@@ -720,8 +720,8 @@ void gp_point_to_xy_fl(
 
 
 /**
-* generic based on gp_point_to_xy_fl
-*/
+ * generic based on gp_point_to_xy_fl
+ */
 void gp_point_3d_to_xy(const GP_SpaceConversion *gsc, const short flag, const float pt[3], float xy[2])
 {
        const ARegion *ar = gsc->ar;
index de4e5e9..9210f72 100644 (file)
@@ -740,8 +740,7 @@ bool ED_mball_select_pick(bContext *C, const int mval[2], bool extend, bool dese
                                metaelem_id += 0x10000;
                        }
 
-                       /* When some metaelem was found, then it is necessary to select or
-                       * deselect it. */
+                       /* When some metaelem was found, then it is necessary to select or deselect it. */
                        if (ml_act) {
                                if (!extend && !deselect && !toggle) {
                                        uint objects_len;
index 964a0ef..d6aa74d 100644 (file)
@@ -260,8 +260,8 @@ static bool object_has_modifier_cb(Object *ob, void *data)
 }
 
 /* Use with ED_object_iter_other(). Sets the total number of levels
-* for any multires modifiers on the object to the int pointed to by
-* callback_data. */
+ * for any multires modifiers on the object to the int pointed to by
+ * callback_data. */
 bool ED_object_multires_update_totlevels_cb(Object *ob, void *totlevel_v)
 {
        ModifierData *md;
index ee4b2bc..49a77af 100644 (file)
@@ -1190,12 +1190,12 @@ static TreeTraversalAction outliner_hide_find_data_to_edit(TreeElement *te, void
                LayerCollection *lc = te->directdata;
 
                if (lc->collection->flag & COLLECTION_IS_MASTER) {
-                       /* skip - showing warning/error message might be misleading
-                       * when deleting multiple collections, so just do nothing */
+                       /* Skip - showing warning/error message might be misleading
+                        * when deleting multiple collections, so just do nothing. */
                }
                else {
-                       /* Delete, duplicate and link don't edit children, those will come along
-                       * with the parents. */
+                       /* Delete, duplicate and link don't edit children,
+                        * those will come along with the parents. */
                        BLI_gset_add(data->collections_to_edit, lc);
                }
        }
index 3fa980f..3aa18f2 100644 (file)
@@ -240,9 +240,8 @@ static bool parent_drop_allowed(SpaceOops *soops, TreeElement *te, Object *poten
        Scene *scene = (Scene *)outliner_search_back(soops, te, ID_SCE);
 
        /* currently outliner organized in a way that if there's no parent scene
-               * element for object it means that all displayed objects belong to
-               * active scene and parenting them is allowed (sergey)
-               */
+        * element for object it means that all displayed objects belong to
+        * active scene and parenting them is allowed (sergey) */
        if (scene) {
                for (ViewLayer *view_layer = scene->view_layers.first;
                     view_layer;
index 2327ead..727706f 100644 (file)
@@ -4548,7 +4548,7 @@ static void applyTrackball(TransInfo *t, const int UNUSED(mval[2]))
 /* Transform (Normal Rotation) */
 
 /** \name Transform Normal Rotation
-* \{ */
+ * \{ */
 
 static void storeCustomLNorValue(TransDataContainer *tc, BMesh *bm)
 {
index 2a00c50..8cd8ba3 100644 (file)
@@ -369,7 +369,7 @@ typedef struct GPUShaderConfigData {
        const char *lib;
        const char *def;
 } GPUShaderConfigData;
-/* shader.c */
+/* gpu_shader.c */
 extern const GPUShaderConfigData GPU_shader_cfg_data[GPU_SHADER_CFG_LEN];
 
 /** Keep these in sync with:
index 0526269..74237f5 100644 (file)
@@ -1097,12 +1097,6 @@ static char *rna_MaterialSlot_path(PointerRNA *ptr)
        return BLI_sprintfN("material_slots[%d]", index);
 }
 
-/* why does this have to be so complicated?, can't all this crap be
- * moved to in BGE conversion function? - Campbell *
- *
- * logic from check_body_type()
- *  */
-
 static char *rna_ObjectDisplay_path(PointerRNA *UNUSED(ptr))
 {
        return BLI_strdup("display");
index c019876..0ae730c 100644 (file)
@@ -357,7 +357,7 @@ PyTypeObject BPyGPUBatch_Type = {
 
 /* -------------------------------------------------------------------- */
 /** \name Public API
-* \{ */
+ * \{ */
 
 PyObject *BPyGPUBatch_CreatePyObject(GPUBatch *batch)
 {