From 9b89de2571b0c3fa2276b5c2ae589e0ec831d1f5 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sat, 3 Jul 2021 23:08:40 +1000 Subject: Cleanup: consistent use of tags: NOTE/TODO/FIXME/XXX Also use doxy style function reference `#` prefix chars when referencing identifiers. --- source/blender/io/collada/AnimationExporter.cpp | 12 ++++++------ source/blender/io/collada/AnimationImporter.cpp | 12 ++++++------ source/blender/io/collada/BCAnimationCurve.h | 2 +- source/blender/io/collada/DocumentImporter.cpp | 6 +++--- source/blender/io/collada/ImageExporter.cpp | 2 +- source/blender/io/collada/MeshImporter.cpp | 6 +++--- source/blender/io/collada/collada_internal.cpp | 2 +- source/blender/io/collada/collada_internal.h | 2 +- source/blender/io/collada/collada_utils.cpp | 8 ++++---- 9 files changed, 26 insertions(+), 26 deletions(-) (limited to 'source/blender/io/collada') diff --git a/source/blender/io/collada/AnimationExporter.cpp b/source/blender/io/collada/AnimationExporter.cpp index 73952b06bc9..9ba59c0414d 100644 --- a/source/blender/io/collada/AnimationExporter.cpp +++ b/source/blender/io/collada/AnimationExporter.cpp @@ -135,7 +135,7 @@ void AnimationExporter::exportAnimation(Object *ob, BCAnimationSampler &sampler) container_is_open = open_animation_container(container_is_open, ob); /* Now take care of the Object Animations - * Note: For Armatures the skeletal animation has already been exported (see above) + * NOTE: For Armatures the skeletal animation has already been exported (see above) * However Armatures also can have Object animation. */ bool export_as_matrix = this->export_settings.get_animation_transformation_type() == @@ -168,7 +168,7 @@ void AnimationExporter::exportAnimation(Object *ob, BCAnimationSampler &sampler) /* * Export all animation FCurves of an Object. * - * Note: This uses the keyframes as sample points, + * NOTE: This uses the keyframes as sample points, * and exports "baked keyframes" while keeping the tangent information * of the FCurves intact. This works for simple cases, but breaks * especially when negative scales are involved in the animation. @@ -337,7 +337,7 @@ void AnimationExporter::export_curve_animation(Object *ob, BCAnimationCurve &cur /* * Some curves can not be exported as is and need some conversion * For more information see implementation of get_modified_export_curve() - * note: if mcurve is not NULL then it must be deleted at end of this method; + * NOTE: if mcurve is not NULL then it must be deleted at end of this method; */ int channel_index = curve.get_channel_index(); @@ -775,7 +775,7 @@ std::string AnimationExporter::get_collada_name(std::string channel_type) const { /* * Translation table to map FCurve animation types to Collada animation. - * Todo: Maybe we can keep the names from the fcurves here instead of + * TODO: Maybe we can keep the names from the fcurves here instead of * mapping. However this is what i found in the old code. So keep * this map for now. */ @@ -799,9 +799,9 @@ std::string AnimationExporter::get_collada_name(std::string channel_type) const {"spot_size", "falloff_angle"}, {"fall_off_exponent", "falloff_exponent"}, {"spot_blend", "falloff_exponent"}, - /* Special blender profile (todo: make this more elegant). */ + /* Special blender profile (TODO: make this more elegant). */ {"blender/blender_dist", "blender/blender_dist"}, - /* Special blender profile (todo: make this more elegant). */ + /* Special blender profile (TODO: make this more elegant). */ {"distance", "blender/blender_dist"}, /* Cameras */ diff --git a/source/blender/io/collada/AnimationImporter.cpp b/source/blender/io/collada/AnimationImporter.cpp index 49f28325257..626e4258239 100644 --- a/source/blender/io/collada/AnimationImporter.cpp +++ b/source/blender/io/collada/AnimationImporter.cpp @@ -164,7 +164,7 @@ void AnimationImporter::animation_to_fcurves(COLLADAFW::AnimationCurve *curve) void AnimationImporter::fcurve_deg_to_rad(FCurve *cu) { for (unsigned int i = 0; i < cu->totvert; i++) { - /* TODO convert handles too */ + /* TODO: convert handles too. */ cu->bezt[i].vec[1][1] *= DEG2RADF(1.0f); cu->bezt[i].vec[0][1] *= DEG2RADF(1.0f); cu->bezt[i].vec[2][1] *= DEG2RADF(1.0f); @@ -174,7 +174,7 @@ void AnimationImporter::fcurve_deg_to_rad(FCurve *cu) void AnimationImporter::fcurve_scale(FCurve *cu, int scale) { for (unsigned int i = 0; i < cu->totvert; i++) { - /* TODO convert handles too */ + /* TODO: convert handles too. */ cu->bezt[i].vec[1][1] *= scale; cu->bezt[i].vec[0][1] *= scale; cu->bezt[i].vec[2][1] *= scale; @@ -305,7 +305,7 @@ bool AnimationImporter::write_animation(const COLLADAFW::Animation *anim) animation_to_fcurves(curve); break; default: - /* TODO there are also CARDINAL, HERMITE, BSPLINE and STEP types. */ + /* TODO: there are also CARDINAL, HERMITE, BSPLINE and STEP types. */ fprintf(stderr, "CARDINAL, HERMITE and BSPLINE anim interpolation types not supported yet.\n"); break; @@ -624,7 +624,7 @@ void AnimationImporter::Assign_transform_animations( } } break; case COLLADAFW::AnimationList::AXISANGLE: - /* TODO convert axis-angle to quat? or XYZ? */ + /* TODO: convert axis-angle to quat? or XYZ? */ default: unused_fcurve(curves); fprintf(stderr, @@ -972,7 +972,7 @@ void AnimationImporter::apply_matrix_curves(Object *ob, /* * This function returns the aspect ration from the Collada camera. * - * Note:COLLADA allows to specify either XFov, or YFov alone. + * NOTE:COLLADA allows to specify either XFov, or YFov alone. * In that case the aspect ratio can be determined from * the viewport aspect ratio (which is 1:1 ?) * XXX: check this: its probably wrong! @@ -1979,7 +1979,7 @@ bool AnimationImporter::evaluate_animation(COLLADAFW::Transformation *tm, return false; } - /* TODO support other animclasses */ + /* TODO: support other animclasses. */ if (animclass != COLLADAFW::AnimationList::ANGLE) { report_class_type_unsupported(path, animclass, type); return false; diff --git a/source/blender/io/collada/BCAnimationCurve.h b/source/blender/io/collada/BCAnimationCurve.h index a1597cd47be..36b2a5e8509 100644 --- a/source/blender/io/collada/BCAnimationCurve.h +++ b/source/blender/io/collada/BCAnimationCurve.h @@ -116,7 +116,7 @@ class BCAnimationCurve { bool is_keyframe(int frame); void adjust_range(int frame); - std::string get_animation_name(Object *ob) const; /* xxx: this is collada specific */ + std::string get_animation_name(Object *ob) const; /* XXX: this is COLLADA specific. */ std::string get_channel_target() const; std::string get_channel_type() const; std::string get_channel_posebone() const; /* returns "" if channel is not a bone channel */ diff --git a/source/blender/io/collada/DocumentImporter.cpp b/source/blender/io/collada/DocumentImporter.cpp index beadfc98c74..35bdc0a4e06 100644 --- a/source/blender/io/collada/DocumentImporter.cpp +++ b/source/blender/io/collada/DocumentImporter.cpp @@ -145,7 +145,7 @@ bool DocumentImporter::import() return false; } - /** TODO set up scene graph and such here */ + /** TODO: set up scene graph and such here. */ mImportStage = Fetching_Controller_data; COLLADASaxFWL::Loader loader2; COLLADAFW::Root root2(&loader2, this); @@ -189,7 +189,7 @@ void DocumentImporter::finish() std::vector *objects_to_scale = new std::vector(); - /** TODO Break up and put into 2-pass parsing of DAE */ + /** TODO: Break up and put into 2-pass parsing of DAE. */ std::vector::iterator sit; for (sit = vscenes.begin(); sit != vscenes.end(); sit++) { PointerRNA sceneptr, unit_settings; @@ -1122,7 +1122,7 @@ bool DocumentImporter::writeLight(const COLLADAFW::Light *light) switch (light->getLightType()) { case COLLADAFW::Light::AMBIENT_LIGHT: { - lamp->type = LA_SUN; /* TODO needs more thoughts */ + lamp->type = LA_SUN; /* TODO: needs more thoughts. */ } break; case COLLADAFW::Light::SPOT_LIGHT: { lamp->type = LA_SPOT; diff --git a/source/blender/io/collada/ImageExporter.cpp b/source/blender/io/collada/ImageExporter.cpp index bb7b3bf0631..4dd7e617459 100644 --- a/source/blender/io/collada/ImageExporter.cpp +++ b/source/blender/io/collada/ImageExporter.cpp @@ -113,7 +113,7 @@ void ImagesExporter::export_UV_Image(Image *image, bool use_copies) /* This image is already located on the file system. * But we want to create copies here. * To move images into the same export directory. - * Note: If an image is already located in the export folder, + * NOTE: If an image is already located in the export folder, * then skip the copy (as it would result in a file copy error). */ if (BLI_path_cmp(source_path, export_path) != 0) { diff --git a/source/blender/io/collada/MeshImporter.cpp b/source/blender/io/collada/MeshImporter.cpp index a33256f9a59..5aa57159328 100644 --- a/source/blender/io/collada/MeshImporter.cpp +++ b/source/blender/io/collada/MeshImporter.cpp @@ -170,7 +170,7 @@ void VCOLDataWrapper::get_vcol(int v_index, MLoopCol *mloopcol) case COLLADAFW::MeshVertexData::DATA_TYPE_FLOAT: { COLLADAFW::ArrayPrimitiveType *values = mVData->getFloatValues(); if (values->empty() || values->getCount() <= (v_index * stride + 2)) { - return; /* xxx need to create an error instead */ + return; /* XXX: need to create an error instead. */ } mloopcol->r = unit_float_to_uchar_clamp((*values)[v_index * stride]); @@ -181,7 +181,7 @@ void VCOLDataWrapper::get_vcol(int v_index, MLoopCol *mloopcol) case COLLADAFW::MeshVertexData::DATA_TYPE_DOUBLE: { COLLADAFW::ArrayPrimitiveType *values = mVData->getDoubleValues(); if (values->empty() || values->getCount() <= (v_index * stride + 2)) { - return; /* xxx need to create an error instead */ + return; /* XXX: need to create an error instead. */ } mloopcol->r = unit_float_to_uchar_clamp((*values)[v_index * stride]); @@ -967,7 +967,7 @@ static void bc_remove_materials_from_object(Object *ob, Mesh *me) /** * Returns the list of Users of the given Mesh object. - * Note: This function uses the object user flag to control + * NOTE: This function uses the object user flag to control * which objects have already been processed. */ std::vector MeshImporter::get_all_users_of(Mesh *reference_mesh) diff --git a/source/blender/io/collada/collada_internal.cpp b/source/blender/io/collada/collada_internal.cpp index 787af933e8f..355aa5c22f0 100644 --- a/source/blender/io/collada/collada_internal.cpp +++ b/source/blender/io/collada/collada_internal.cpp @@ -71,7 +71,7 @@ void UnitConverter::convertVector3(COLLADABU::Math::Vector3 &vec, float *v) v[2] = vec.z; } -/* TODO need also for angle conversion, time conversion... */ +/* TODO: need also for angle conversion, time conversion... */ void UnitConverter::dae_matrix_to_mat4_(float out[4][4], const COLLADABU::Math::Matrix4 &in) { diff --git a/source/blender/io/collada/collada_internal.h b/source/blender/io/collada/collada_internal.h index 1d2ed11bfe6..e3894093507 100644 --- a/source/blender/io/collada/collada_internal.h +++ b/source/blender/io/collada/collada_internal.h @@ -62,7 +62,7 @@ class UnitConverter { float getLinearMeter(void); - /* TODO need also for angle conversion, time conversion... */ + /* TODO: need also for angle conversion, time conversion... */ static void dae_matrix_to_mat4_(float out[4][4], const COLLADABU::Math::Matrix4 &in); static void mat4_to_dae(float out[4][4], float in[4][4]); diff --git a/source/blender/io/collada/collada_utils.cpp b/source/blender/io/collada/collada_utils.cpp index d7855d69d99..9967a526971 100644 --- a/source/blender/io/collada/collada_utils.cpp +++ b/source/blender/io/collada/collada_utils.cpp @@ -159,7 +159,7 @@ std::vector bc_getSceneActions(const bContext *C, Object *ob, bool al for (id = (ID *)bmain->actions.first; id; id = (ID *)(id->next)) { bAction *act = (bAction *)id; /* XXX This currently creates too many actions. - * TODO Need to check if the action is compatible to the given object. */ + * TODO: Need to check if the action is compatible to the given object. */ actions.push_back(act); } } @@ -281,7 +281,7 @@ bool bc_has_object_type(LinkNode *export_set, short obtype) for (node = export_set; node; node = node->next) { Object *ob = (Object *)node->link; - /* XXX - why is this checking for ob->data? - we could be looking for empties */ + /* XXX: why is this checking for ob->data? - we could be looking for empties. */ if (ob->type == obtype && ob->data) { return true; } @@ -728,7 +728,7 @@ void bc_set_IDPropertyMatrix(EditBone *ebone, const char *key, float mat[4][4]) /** * Stores a Float value as a custom bone property * - * Note: This function is currently not needed. Keep for future usage + * NOTE: This function is currently not needed. Keep for future usage */ static void bc_set_IDProperty(EditBone *ebone, const char *key, float value) { @@ -1018,7 +1018,7 @@ void bc_apply_global_transform(Vector &to_vec, const BCMatrix &global_transform, * Check if custom information about bind matrix exists and modify the from_mat * accordingly. * - * Note: This is old style for Blender <= 2.78 only kept for compatibility + * NOTE: This is old style for Blender <= 2.78 only kept for compatibility */ void bc_create_restpose_mat(BCExportSettings &export_settings, Bone *bone, -- cgit v1.2.3