[Bf-blender-cvs] [e757c4a3bec] master: Cleanup: use colon separator after parameter

Campbell Barton noreply at git.blender.org
Wed Dec 12 02:52:18 CET 2018


Commit: e757c4a3bec8b0e8d198531a28327332af00a9ba
Author: Campbell Barton
Date:   Wed Dec 12 12:50:58 2018 +1100
Branches: master
https://developer.blender.org/rBe757c4a3bec8b0e8d198531a28327332af00a9ba

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.

===================================================================

M	source/blender/alembic/intern/alembic_capi.cc
M	source/blender/blenkernel/BKE_idcode.h
M	source/blender/blenkernel/intern/action.c
M	source/blender/blenkernel/intern/anim.c
M	source/blender/blenkernel/intern/anim_sys.c
M	source/blender/blenkernel/intern/appdir.c
M	source/blender/blenkernel/intern/armature.c
M	source/blender/blenkernel/intern/autoexec.c
M	source/blender/blenkernel/intern/brush.c
M	source/blender/blenkernel/intern/bvhutils.c
M	source/blender/blenkernel/intern/cachefile.c
M	source/blender/blenkernel/intern/camera.c
M	source/blender/blenkernel/intern/cdderivedmesh.c
M	source/blender/blenkernel/intern/colortools.c
M	source/blender/blenkernel/intern/context.c
M	source/blender/blenkernel/intern/curve.c
M	source/blender/blenkernel/intern/customdata.c
M	source/blender/blenkernel/intern/displist.c
M	source/blender/blenkernel/intern/gpencil.c
M	source/blender/blenkernel/intern/group.c
M	source/blender/blenkernel/intern/idcode.c
M	source/blender/blenkernel/intern/idprop.c
M	source/blender/blenkernel/intern/image.c
M	source/blender/blenkernel/intern/key.c
M	source/blender/blenkernel/intern/lamp.c
M	source/blender/blenkernel/intern/lattice.c
M	source/blender/blenkernel/intern/library.c
M	source/blender/blenkernel/intern/library_query.c
M	source/blender/blenkernel/intern/linestyle.c
M	source/blender/blenkernel/intern/mask.c
M	source/blender/blenkernel/intern/material.c
M	source/blender/blenkernel/intern/mball.c
M	source/blender/blenkernel/intern/mesh.c
M	source/blender/blenkernel/intern/mesh_evaluate.c
M	source/blender/blenkernel/intern/mesh_mapping.c
M	source/blender/blenkernel/intern/mesh_validate.c
M	source/blender/blenkernel/intern/modifier.c
M	source/blender/blenkernel/intern/movieclip.c
M	source/blender/blenkernel/intern/nla.c
M	source/blender/blenkernel/intern/node.c
M	source/blender/blenkernel/intern/object.c
M	source/blender/blenkernel/intern/object_deform.c
M	source/blender/blenkernel/intern/paint.c
M	source/blender/blenkernel/intern/particle.c
M	source/blender/blenkernel/intern/rigidbody.c
M	source/blender/blenkernel/intern/scene.c
M	source/blender/blenkernel/intern/sound.c
M	source/blender/blenkernel/intern/speaker.c
M	source/blender/blenkernel/intern/text.c
M	source/blender/blenkernel/intern/texture.c
M	source/blender/blenkernel/intern/world.c
M	source/blender/blenlib/BLI_astar.h
M	source/blender/blenlib/PIL_time.h
M	source/blender/blenlib/intern/BLI_dynstr.c
M	source/blender/blenlib/intern/BLI_ghash.c
M	source/blender/blenlib/intern/BLI_kdtree.c
M	source/blender/blenlib/intern/BLI_mempool.c
M	source/blender/blenlib/intern/astar.c
M	source/blender/blenlib/intern/convexhull_2d.c
M	source/blender/blenlib/intern/edgehash.c
M	source/blender/blenlib/intern/fileops.c
M	source/blender/blenlib/intern/freetypefont.c
M	source/blender/blenlib/intern/gsqueue.c
M	source/blender/blenlib/intern/listbase.c
M	source/blender/blenlib/intern/math_base_inline.c
M	source/blender/blenlib/intern/math_geom.c
M	source/blender/blenlib/intern/math_geom_inline.c
M	source/blender/blenlib/intern/math_rotation.c
M	source/blender/blenlib/intern/math_solvers.c
M	source/blender/blenlib/intern/math_statistics.c
M	source/blender/blenlib/intern/path_util.c
M	source/blender/blenlib/intern/string.c
M	source/blender/blenlib/intern/string_utf8.c
M	source/blender/blenlib/intern/string_utils.c
M	source/blender/blenlib/intern/task.c
M	source/blender/blenlib/intern/timecode.c
M	source/blender/blenloader/intern/readblenentry.c
M	source/blender/blenloader/intern/readfile.c
M	source/blender/blenloader/intern/writefile.c
M	source/blender/bmesh/intern/bmesh_construct.c
M	source/blender/bmesh/intern/bmesh_core.c
M	source/blender/bmesh/intern/bmesh_mesh_conv.c
M	source/blender/bmesh/intern/bmesh_mods.c
M	source/blender/bmesh/intern/bmesh_operators.c
M	source/blender/bmesh/intern/bmesh_polygon.c
M	source/blender/bmesh/intern/bmesh_query.c
M	source/blender/bmesh/operators/bmo_fill_grid.c
M	source/blender/bmesh/operators/bmo_normals.c
M	source/blender/bmesh/operators/bmo_primitive.c
M	source/blender/bmesh/tools/bmesh_bisect_plane.c
M	source/blender/bmesh/tools/bmesh_decimate_collapse.c
M	source/blender/bmesh/tools/bmesh_decimate_unsubdivide.c
M	source/blender/bmesh/tools/bmesh_edgenet.c
M	source/blender/bmesh/tools/bmesh_edgesplit.c
M	source/blender/bmesh/tools/bmesh_intersect.c
M	source/blender/bmesh/tools/bmesh_region_match.c
M	source/blender/collada/DocumentImporter.h
M	source/blender/compositor/COM_compositor.h
M	source/blender/compositor/intern/COM_CPUDevice.h
M	source/blender/compositor/intern/COM_Converter.h
M	source/blender/compositor/intern/COM_Device.h
M	source/blender/compositor/intern/COM_ExecutionGroup.h
M	source/blender/compositor/intern/COM_ExecutionSystem.h
M	source/blender/compositor/intern/COM_MemoryBuffer.h
M	source/blender/compositor/intern/COM_MemoryProxy.h
M	source/blender/compositor/intern/COM_Node.h
M	source/blender/compositor/intern/COM_NodeOperation.h
M	source/blender/compositor/intern/COM_OpenCLDevice.h
M	source/blender/compositor/intern/COM_SocketReader.h
M	source/blender/compositor/intern/COM_WorkPackage.h
M	source/blender/compositor/intern/COM_WorkScheduler.h
M	source/blender/compositor/operations/COM_BokehImageOperation.h
M	source/blender/compositor/operations/COM_PixelateOperation.h
M	source/blender/compositor/operations/COM_SunBeamsOperation.cpp
M	source/blender/editors/animation/anim_channels_edit.c
M	source/blender/editors/animation/anim_markers.c
M	source/blender/editors/armature/armature_utils.c
M	source/blender/editors/armature/pose_transform.c
M	source/blender/editors/gpencil/editaction_gpencil.c
M	source/blender/editors/gpencil/gpencil_intern.h
M	source/blender/editors/gpencil/gpencil_utils.c
M	source/blender/editors/include/BIF_glutil.h
M	source/blender/editors/interface/interface.c
M	source/blender/editors/interface/interface_handlers.c
M	source/blender/editors/mesh/editmesh_knife.c
M	source/blender/editors/mesh/editmesh_rip.c
M	source/blender/editors/mesh/editmesh_select.c
M	source/blender/editors/mesh/editmesh_utils.c
M	source/blender/editors/screen/area.c
M	source/blender/editors/screen/glutil.c
M	source/blender/editors/sculpt_paint/sculpt.c
M	source/blender/editors/space_file/fsmenu.h
M	source/blender/editors/space_image/image_ops.c
M	source/blender/editors/space_node/node_edit.c
M	source/blender/editors/space_text/text_format.c
M	source/blender/editors/space_view3d/drawobject.c
M	source/blender/editors/space_view3d/view3d_camera_control.c
M	source/blender/editors/space_view3d/view3d_edit.c
M	source/blender/editors/space_view3d/view3d_project.c
M	source/blender/editors/space_view3d/view3d_utils.c
M	source/blender/editors/space_view3d/view3d_view.c
M	source/blender/editors/space_view3d/view3d_walk.c
M	source/blender/editors/transform/transform.c
M	source/blender/editors/transform/transform_generics.c
M	source/blender/editors/util/ed_util.c
M	source/blender/freestyle/intern/image/GaussianFilter.h
M	source/blender/freestyle/intern/image/Image.h
M	source/blender/freestyle/intern/image/ImagePyramid.h
M	source/blender/freestyle/intern/scene_graph/FrsMaterial.h
M	source/blender/freestyle/intern/scene_graph/NodeCamera.h
M	source/blender/freestyle/intern/stroke/AdvancedFunctions0D.h
M	source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h
M	source/blender/freestyle/intern/stroke/AdvancedPredicates1D.h
M	source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h
M	source/blender/freestyle/intern/stroke/BasicStrokeShaders.h
M	source/blender/freestyle/intern/stroke/Canvas.h
M	source/blender/freestyle/intern/stroke/Chain.h
M	source/blender/freestyle/intern/stroke/ChainingIterators.h
M	source/blender/freestyle/intern/stroke/ContextFunctions.h
M	source/blender/freestyle/intern/stroke/Curve.h
M	source/blender/freestyle/intern/stroke/Operators.h
M	source/blender/freestyle/intern/stroke/Predicates0D.h
M	source/blender/freestyle/intern/stroke/Predicates1D.h
M	source/blender/freestyle/intern/stroke/Stroke.h
M	source/blender/freestyle/intern/stroke/StrokeShader.h
M	source/blender/freestyle/intern/view_map/FEdgeXDetector.h
M	source/blender/freestyle/intern/view_map/Functions0D.h
M	source/blender/freestyle/intern/view_map/Functions1D.h
M	source/blender/freestyle/intern/view_map/Interface1D.h
M	source/blender/freestyle/intern/view_map/Silhouette.h
M	source/blender/freestyle/intern/view_map/SteerableViewMap.h
M	source/blender/freestyle/intern/view_map/ViewMap.h
M	source/blender/freestyle/intern/view_map/ViewMapIterators.h
M	source/blender/imbuf/IMB_metadata.h
M	source/blender/imbuf/intern/openexr/openexr_api.cpp
M	source/blender/makesdna/intern/dna_genfile.c
M	source/blender/makesdna/intern/makesdna.c
M	source/blender/makesrna/intern/rna_define.c
M	source/blender/modifiers/intern/MOD_solidify.c
M	source/blender/physics/intern/ConstrainedConjugateGradient.h
M	source/blender/python/bmesh/bmesh_py_ops_call.c
M	source/blender/python/mathutils/mathutils_Matrix.c
M	source/blender/render/intern/include/shadbuf.h
M	source/blender/render/intern/source/pixelshading.c
M	source/blender/render/intern/source/zbuf.c
M	source/blender/windowmanager/intern/wm.c
M	source/blender/windowmanager/intern/wm_cursors.c
M	source/blender/windowmanager/intern/wm_event_system.c
M	source/blender/windowmanager/intern/wm_operators.c
M	source/blender/windowmanager/intern/wm_window.c

===================================================================

diff --git a/source/blender/alembic/intern/alembic_capi.cc b/source/blender/alembic/intern/alembic_capi.cc
index b7c1f98bfb0..4b41277f0df 100644
--- a/source/blender/alembic/intern/alembic_capi.cc
+++ b/source/blender/alembic/intern/alembic_capi.cc
@@ -395,11 +395,11 @@ bool ABC_export(
 /**
  * Generates an AbcObjectReader for this Alembic object and its children.
  *
- * \param object The Alembic IObject to visit.
- * \param readers The created AbcObjectReader * will be appended to this vector.
- * \param settings Import settings, not used directly but passed to the
+ * \param object: The Alembic IObject to visit.
+ * \param readers: The created AbcObjectReader * will be appended to this vector.
+ * \param settings: Import settings, not used directly but passed to the
  *                 AbcObjectReader subclass constructors.
- * \param r_assign_as_parent Return parameter, contains a list of reader
+ * \param r_assign_as_parent: Return parameter, contains a list of reader
  *                 pointers, whose parent pointer should still be set.
  *                 This is filled when this call to visit_object() didn't create
  *                 a reader that should be the parent.
diff --git a/source/blender/blenkernel/BKE_idcode.h b/source/blender/blenkernel/BKE_idcode.h
index 964a49435f1..2400d02a21d 100644
--- a/source/blender/blenkernel/BKE_idcode.h
+++ b/source/blender/blenkernel/BKE_idcode.h
@@ -47,7 +47,7 @@ int BKE_idcode_to_index(const short idcode);
 /**
  * Return an ID code and steps the index forward 1.
  *
- * \param index start as 0.
+ * \param index: start as 0.
  * \return the code, 0 when all codes have been returned.
  */
 short BKE_idcode_iter_step(int *index);
diff --git a/source/blender/blenkernel/intern/action.c b/source/blender/blenkernel/intern/action.c
index 7612e9a3fdb..bbd7511842f 100644
--- a/source/blender/blenkernel/intern/action.c
+++ b/source/blender/blenkernel/intern/action.c
@@ -126,7 +126,7 @@ void BKE_action_free(bAction *act)
  *
  * WARNING! This function will not handle ID user count!
  *
- * \param flag  Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
+ * \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
  */
 void BKE_action_copy_data(Main *UNUSED(bmain), bAction *act_dst, const bAction *act_src, const int UNUSED(flag))
 {
@@ -531,7 +531,7 @@ const char *BKE_pose_ikparam_get_name(bPose *pose)
  * Allocate a new pose on the heap, and copy the src pose and it's channels
  * into the new pose. *dst is set to the newly allocated structure, and assumed to be NULL.
  *
- * \param dst  Should be freed already, makes entire duplicate.
+ * \param dst: Should be freed already, makes entire duplicate.
  */
 void BKE_pose_copy_data_ex(bPose **dst, const bPose *src, const int flag, const bool copy_constraints)
 {
diff --git a/source/blender/blenkernel/intern/anim.c b/source/blender/blenkernel/intern/anim.c
index d5f269b82a8..45e1de49092 100644
--- a/source/blender/blenkernel/intern/anim.c
+++ b/source/blender/blenkernel/intern/anim.c
@@ -129,9 +129,9 @@ void animviz_free_motionpath(bMotionPath *mpath)
  * Setup motion paths for the given data.
  * \note Only used when explicitly calculating paths on bones which may/may not be consider already
  *
- * \param scene Current scene (for frame ranges, etc.)
- * \param ob Object to add paths for (must be provided)
- * \param pchan Posechannel to add paths for (optional; if not provided, object-paths are assumed)
+ * \param scene: Current scene (for frame ranges, etc.)
+ * \param ob: Object to add paths for (must be provided)
+ * \param pchan: Posechannel to add paths for (optional; if not provided, object-paths are assumed)
  */
 bMotionPath *animviz_verify_motionpaths(ReportList *reports, Scene *scene, Object *ob, bPoseChannel *pchan)
 {
diff --git a/source/blender/blenkernel/intern/anim_sys.c b/source/blender/blenkernel/intern/anim_sys.c
index 500ece2a735..d0262579663 100644
--- a/source/blender/blenkernel/intern/anim_sys.c
+++ b/source/blender/blenkernel/intern/anim_sys.c
@@ -409,8 +409,8 @@ void BKE_animdata_merge_copy(
 /**
  * Helper heuristic for determining if a path is compatible with the basepath
  *
- * \param path Full RNA-path from some data (usually an F-Curve) to compare
- * \param basepath Shorter path fragment to look for
+ * \param path: Full RNA-path from some data (usually an F-Curve) to compare
+ * \param basepath: Shorter path fragment to look for
  * \return Whether there is a match
  */
 static bool animpath_matches_basepath(const char path[], const char basepath[])
@@ -582,9 +582,9 @@ void BKE_animdata_separate_by_basepath(
  * such drivers by rerouting all paths through the active object instead so that
  * they will get picked up by the dependency system.
  *
- * \param C Context pointer - for getting active data
+ * \param C: Context pointer - for getting active data
  * \param[in,out] ptr RNA pointer for property's datablock. May be modified as result of path remapping.
- * \param prop RNA definition of property to add for
+ * \param prop: RNA definition of property to add for
  * \return MEM_alloc'd string representing the path to the property from the given #PointerRNA
  */
 char *BKE_animdata_driver_path_hack(bContext *C, PointerRNA *ptr, PropertyRNA *prop, char *base_path)
diff --git a/source/blender/blenkernel/intern/appdir.c b/source/blender/blenkernel/intern/appdir.c
index 8d6c34222d7..ecd37c8dab5 100644
--- a/source/blender/blenkernel/intern/appdir.c
+++ b/source/blender/blenkernel/intern/appdir.c
@@ -182,10 +182,10 @@ static bool test_env_path(char *path, const char *envvar)
  * Constructs in \a targetpath the name of a directory relative to a version-specific
  * subdirectory in the parent directory of the Blender executable.
  *
- * \param targetpath  String to return path
- * \param folder_name  Optional folder name within version-specific directory
- * \param subfolder_name  Optional subfolder name within folder_name
- * \param ver  To construct name of version-specific directory within bprogdir
+ * \param targetpath: String to return path
+ * \param folder_name: Optional folder name within version-specific directory
+ * \param subfolder_name: Optional subfolder name within folder_name
+ * \param ver: To construct name of version-specific directory within bprogdir
  * \return true if such a directory exists.
  */
 static bool get_path_local(
@@ -273,10 +273,10 @@ static bool get_path_environment(
  * Returns the path of a folder within the user-files area.
  *
  *
- * \param targetpath  String to return path
- * \param folder_name  default name of folder within user area
- * \param subfolder_name  optional name of subfolder within folder
-  * \param ver  Blender version, used to construct a subdirectory name
+ * \param targetpath: String to return path
+ * \param folder_name: default name of folder within user area
+ * \param subfolder_name: optional name of subfolder within folder
+  * \param ver: Blender version, used to construct a subdirectory name
  * \return true if it was able to construct such a path.
  */
 static bool get_path_user(
@@ -314,10 +314,10 @@ static bool get_path_user(
 /**
  * Returns the path of a folder within the Blender installation directory.
  *
- * \param targetpath  String to return path
- * \param folder_name  default name of folder within installation area
- * \param subfolder_name  optional name of subfolder within folder
- * \param ver  Blender version, used to construct a subdirectory name
+ * \param targetpath: String to return path
+ * \param folder_name: default name of folder within installation area
+ * \param subfolder_name: optional name of subfolder within folder
+ * \param ver: Blender version, used to construct a subdirectory name
  * \return  true if it was able to construct such a path.
  */
 static bool get_path_system(
@@ -542,9 +542,9 @@ const char *BKE_appdir_folder_id_version(const int folder_id, const int ver, con
  * the name to its 8.3 version to prevent problems with
  * spaces and stuff. Final result is returned in fullname.
  *
- * \param fullname The full path and full name of the executable
+ * \param fullname: The full path and full name of the executable
  * (must be FILE_MAX minimum)
- * \param name The name of the executable (usually argv[0]) to be checked
+ * \param name: The name of the executable (usually argv[0]) to be checked
  */
 static void where_am_i(char *fullname, const size_t maxlen, const char *name)
 {
@@ -744,10 +744,10 @@ bool BKE_appdir_app_template_id_search(const char *app_template, char *path, siz
  *
  * Also make sure the temp dir has a trailing slash
  *
- * \param fullname The full path to the temporary temp directory
- * \param basename The full path to the persistent temp directory (may be NULL)
- * \param maxlen The size of the fullname buffer
- * \param userdir Directory specified in user preferences
+ * \param fullname: The full path to the temporary temp directory
+ * \param basename: The full path to the persistent temp directory (may be NULL)
+ * \param maxlen: The size of the fullname buffer
+ * \param userdir: Directory specified in user preferences
  */
 static void where_is_temp(char *fullname, char *basename, const size_t maxlen, char *userdir)
 {
diff --git a/source/blender/blenkernel/intern/armature.c b/source/blender/blenkernel/intern/armature.c
index 0f9c79c5e3e..65b6b2fe3b2 100644
--- a/source/blender/blenkernel/intern/armature.c
+++ b/source/blender/blenkernel/intern/armature.c
@@ -181,7 +181,7 @@ static void copy_bonechildren(
  *
  * WARNING! This function will not handle ID user count!
  *
- * \param flag  Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
+ * \param flag: Copying options (see BKE_library.h's LIB_ID_COPY_... flags for more).
  */
 void BKE_armature_copy_data(Main *UNUSED(bmain), bArmature *arm_dst, const bArmature *arm_src, const int flag)
 {
diff --git a/source/blender/blenkernel/intern/autoexec.c b/source/blender/blenkernel/intern/autoexec.c
index bde06b02ae8..708820877d9 100644
--- a/source/blender/blenkernel/intern/autoexec.c
+++ b/source/blender/blenkernel/intern/autoexec.c
@@ -43,7 +43,7 @@
 #include "BKE_autoexec.h"  /* own incl

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list