Cleanup: doxygen comments
authorCampbell Barton <ideasman42@gmail.com>
Sun, 24 Nov 2019 14:14:39 +0000 (01:14 +1100)
committerCampbell Barton <ideasman42@gmail.com>
Sun, 24 Nov 2019 14:51:11 +0000 (01:51 +1100)
Also correct some outdated symbol references,
add missing 'name' commands.

89 files changed:
intern/ghost/intern/GHOST_ContextCGL.mm
intern/memutil/MEM_RefCountedC-Api.h
source/blender/blenkernel/BKE_DerivedMesh.h
source/blender/blenkernel/BKE_customdata.h
source/blender/blenkernel/BKE_node.h
source/blender/blenkernel/intern/action.c
source/blender/blenkernel/intern/anim_sys.c
source/blender/blenkernel/intern/armature.c
source/blender/blenkernel/intern/colortools.c
source/blender/blenkernel/intern/crazyspace.c
source/blender/blenkernel/intern/curveprofile.c
source/blender/blenkernel/intern/font.c
source/blender/blenkernel/intern/gpencil.c
source/blender/blenkernel/intern/icons.c
source/blender/blenkernel/intern/key.c
source/blender/blenkernel/intern/library.c
source/blender/blenkernel/intern/library_override.c
source/blender/blenkernel/intern/library_remap.c
source/blender/blenkernel/intern/mball.c
source/blender/blenkernel/intern/mesh_evaluate.c
source/blender/blenkernel/intern/object.c
source/blender/blenkernel/intern/scene.c
source/blender/blenkernel/intern/screen.c
source/blender/blenkernel/intern/studiolight.c
source/blender/blenkernel/intern/undo_system.c
source/blender/blenlib/BLI_array.h
source/blender/blenlib/BLI_rand.h
source/blender/blenlib/BLI_voxel.h
source/blender/blenlib/intern/delaunay_2d.c
source/blender/blenlib/intern/hash_md5.c
source/blender/blenlib/intern/kdtree_impl.h
source/blender/blenlib/intern/math_base_inline.c
source/blender/blenlib/intern/math_geom.c
source/blender/blenlib/intern/math_matrix.c
source/blender/blenlib/intern/math_rotation.c
source/blender/blenlib/intern/path_util.c
source/blender/bmesh/intern/bmesh_core.c
source/blender/bmesh/intern/bmesh_mesh.c
source/blender/bmesh/operators/bmo_subdivide_edgering.c
source/blender/bmesh/tools/bmesh_bevel.c
source/blender/bmesh/tools/bmesh_decimate_collapse.c
source/blender/collada/DocumentImporter.cpp
source/blender/compositor/intern/COM_ExecutionGroup.cpp
source/blender/compositor/intern/COM_NodeGraph.cpp
source/blender/compositor/intern/COM_NodeGraph.h
source/blender/draw/engines/eevee/shaders/lit_surface_frag.glsl
source/blender/editors/armature/armature_add.c
source/blender/editors/curve/editcurve.c
source/blender/editors/interface/interface_handlers.c
source/blender/editors/interface/interface_ops.c
source/blender/editors/interface/interface_templates.c
source/blender/editors/interface/interface_widgets.c
source/blender/editors/interface/resources.c
source/blender/editors/mesh/meshtools.c
source/blender/editors/object/object_transform.c
source/blender/editors/sculpt_paint/paint_image_proj.c
source/blender/editors/space_file/fsmenu.h
source/blender/editors/space_outliner/outliner_draw.c
source/blender/editors/space_outliner/outliner_tools.c
source/blender/editors/space_view3d/view3d_select.c
source/blender/editors/space_view3d/view3d_snap.c
source/blender/editors/space_view3d/view3d_view.c
source/blender/editors/transform/transform.h
source/blender/editors/transform/transform_convert_mesh.c
source/blender/editors/transform/transform_snap_object.c
source/blender/editors/util/numinput.c
source/blender/gpu/GPU_shader.h
source/blender/gpu/shaders/material/gpu_shader_material_tex_image.glsl
source/blender/imbuf/IMB_metadata.h
source/blender/imbuf/IMB_thumbs.h
source/blender/imbuf/intern/rectop.c
source/blender/imbuf/intern/thumbs.c
source/blender/makesdna/DNA_curveprofile_types.h
source/blender/makesdna/DNA_customdata_types.h
source/blender/makesdna/DNA_meshdata_types.h
source/blender/makesdna/DNA_object_enums.h
source/blender/makesdna/DNA_object_force_types.h
source/blender/makesdna/DNA_scene_types.h
source/blender/makesdna/DNA_space_types.h
source/blender/makesdna/DNA_userdef_types.h
source/blender/makesdna/intern/makesdna.c
source/blender/makesrna/RNA_types.h
source/blender/makesrna/intern/rna_access_compare_override.c
source/blender/modifiers/intern/MOD_weightvgproximity.c
source/blender/python/bmesh/bmesh_py_types_meshdata.c
source/blender/python/intern/bpy_rna.c
source/blender/windowmanager/WM_api.h
source/blender/windowmanager/gizmo/intern/wm_gizmo.c
source/blender/windowmanager/intern/wm_operators.c

index 12c340ffe97c35dfe8dc06cffbb10215a1dcce07..1fbce0c1e6bbb096357131e2c78340842082f496 100644 (file)
@@ -17,7 +17,7 @@
  * All rights reserved.
  */
 
-/** \file ghost/intern/GHOST_ContextCGL.mm
+/** \file
  *  \ingroup GHOST
  *
  * Definition of GHOST_ContextCGL class.
index 25dcf11b7aa034dbb4cd9233c82a371941e9d0d6..2a132f3c1735983cc64f8bdef7fe8757e8a148ad 100644 (file)
@@ -37,23 +37,23 @@ extern "C" {
 
 /**
  * Returns the reference count of this object.
- * @param shared The object to query.
- * @return The current reference count.
+ * \param shared: The object to query.
+ * \return The current reference count.
  */
 extern int MEM_RefCountedGetRef(MEM_TRefCountedObjectPtr shared);
 
 /**
  * Increases the reference count of this object.
- * @param shared The object to query.
- * @return The new reference count.
+ * \param shared: The object to query.
+ * \return The new reference count.
  */
 extern int MEM_RefCountedIncRef(MEM_TRefCountedObjectPtr shared);
 
 /**
  * Decreases the reference count of this object.
  * If the reference count reaches zero, the object self-destructs.
- * @param shared The object to query.
- * @return The new reference count.
+ * \param shared: The object to query.
+ * \return The new reference count.
  */
 extern int MEM_RefCountedDecRef(MEM_TRefCountedObjectPtr shared);
 
index 2145a673e45dd6498631fef41440d2020236b9e2..e167cfd6fcbd84571e2d4375bda3c9a1d5e99a05 100644 (file)
@@ -296,8 +296,9 @@ void DM_from_template(DerivedMesh *dm,
                       int numLoops,
                       int numPolys);
 
-/** utility function to release a DerivedMesh's layers
- * returns 1 if DerivedMesh has to be released by the backend, 0 otherwise
+/**
+ * Utility function to release a DerivedMesh's layers
+ * returns 1 if DerivedMesh has to be released by the backend, 0 otherwise.
  */
 int DM_release(DerivedMesh *dm);
 
index f354e5e6de395f164d98f8bd65f35899fa3b2493..f5665707a0c193aa3f75a0cd09e7a715e17eb7d4 100644 (file)
@@ -168,8 +168,8 @@ bool CustomData_bmesh_merge(const struct CustomData *source,
 /** NULL's all members and resets the typemap. */
 void CustomData_reset(struct CustomData *data);
 
-/** frees data associated with a CustomData object (doesn't free the object
- * itself, though)
+/**
+ * Frees data associated with a CustomData object (doesn't free the object itself, though).
  */
 void CustomData_free(struct CustomData *data, int totelem);
 
index a5b9b1e5148e2e71d5751d77fab5aaaa8e8146fa..9501d3f8ec9808dd376594e0ef373757dfe6beb4 100644 (file)
@@ -74,7 +74,9 @@ struct uiLayout;
 /** \name Node Type Definitions
  * \{ */
 
-/** Compact definition of a node socket.
+/**
+ * \brief Compact definition of a node socket.
+ *
  * Can be used to quickly define a list of static sockets for a node,
  * which are added to each new node of that type.
  *
@@ -95,7 +97,9 @@ typedef struct bNodeSocketTemplate {
   char identifier[64];      /* generated from name */
 } bNodeSocketTemplate;
 
-/** Defines a socket type.
+/**
+ * \brief Defines a socket type.
+ *
  * Defines the appearance and behavior of a socket in the UI.
  */
 typedef struct bNodeSocketType {
@@ -155,7 +159,9 @@ typedef int (*NodeGPUExecFunction)(struct GPUMaterial *mat,
                                    struct GPUNodeStack *in,
                                    struct GPUNodeStack *out);
 
-/** Defines a node type.
+/**
+ * \brief Defines a node type.
+ *
  * Initial attributes and constants for a node as well as callback functions
  * implementing the node behavior.
  */
index de1cbd236fbd35696b8be9fe9676b9a12ac0b12b..ad6c696b655c6a451f2fa4fe216d5fe6d01d1842 100644 (file)
@@ -502,9 +502,10 @@ bool BKE_pose_channels_is_valid(const bPose *pose)
 #endif
 
 /**
- * Find the active posechannel for an object (we can't just use pose, as layer info is in armature)
+ * Find the active pose-channel for an object
+ * (we can't just use pose, as layer info is in armature)
  *
- * \note: Object, not bPose is used here, as we need layer info from Armature)
+ * \note #Object, not #bPose is used here, as we need layer info from Armature.
  */
 bPoseChannel *BKE_pose_channel_active(Object *ob)
 {
index 2e655452a211a6442753fc83cd36b6c9f357eb39..88a8463b99404688f5d2726a4118d667f59da7ac 100644 (file)
@@ -180,8 +180,10 @@ AnimData *BKE_animdata_add_id(ID *id)
 
 /* Action Setter --------------------------------------- */
 
-/** Called when user tries to change the active action of an AnimData block
- * (via RNA, Outliner, etc.) */
+/**
+ * Called when user tries to change the active action of an AnimData block
+ * (via RNA, Outliner, etc.)
+ */
 bool BKE_animdata_set_action(ReportList *reports, ID *id, bAction *act)
 {
   AnimData *adt = BKE_animdata_from_id(id);
index 4d9a92d3eadd0e5ad6970a4dcb393adb6b66d99e..58b0c9b41ea926168c35f4df3c1577e26ca9243f 100644 (file)
@@ -1239,8 +1239,10 @@ void BKE_pchan_bbone_segments_cache_copy(bPoseChannel *pchan, bPoseChannel *pcha
   }
 }
 
-/** Calculate index and blend factor for the two B-Bone segment nodes
- * affecting the point at 0 <= pos <= 1. */
+/**
+ * Calculate index and blend factor for the two B-Bone segment nodes
+ * affecting the point at 0 <= pos <= 1.
+ */
 void BKE_pchan_bbone_deform_segment_index(const bPoseChannel *pchan,
                                           float pos,
                                           int *r_index,
index b129bf14bb82472a552ab942a9a784105e5be323..8166bbea962aeaea2a7a1d608a6cfe44ce43205d 100644 (file)
@@ -1051,7 +1051,8 @@ static void curvemapping_evaluateRGBF_filmlike(const CurveMapping *cumap,
   vecout[channel_offset[2]] = v2;
 }
 
-/** same as #BKE_curvemapping_evaluate_premulRGBF
+/**
+ * Same as #BKE_curvemapping_evaluate_premulRGBF
  * but black/bwmul are passed as args for the compositor
  * where they can change per pixel.
  *
index f2ed84b412501b83e028fe0d997f3a67bfff9f06..9618ef8c78efebc6de1f40ce16ddc5c943f1e680 100644 (file)
@@ -251,8 +251,10 @@ void BKE_crazyspace_set_quats_mesh(Mesh *me,
   }
 }
 
-/** returns an array of deform matrices for crazyspace correction, and the
- * number of modifiers left */
+/**
+ * Returns an array of deform matrices for crazyspace correction,
+ * and the number of modifiers left.
+ */
 int BKE_crazyspace_get_first_deform_matrices_editbmesh(struct Depsgraph *depsgraph,
                                                        Scene *scene,
                                                        Object *ob,
index f07d29c08077fc14ec481437ac0a0a5bf0dbefbf..2b253d439e022db3d75ae2346f9e6fa89f5dc681 100644 (file)
@@ -75,8 +75,10 @@ CurveProfile *BKE_curveprofile_copy(const CurveProfile *profile)
   return NULL;
 }
 
-/** Removes a specific point from the path of control points.
- * \note: Requires curveprofile_update call after. */
+/**
+ * Removes a specific point from the path of control points.
+ * \note Requires #BKE_curveprofile_update call after.
+ */
 bool BKE_curveprofile_remove_point(CurveProfile *profile, CurveProfilePoint *point)
 {
   CurveProfilePoint *pts;
@@ -105,9 +107,13 @@ bool BKE_curveprofile_remove_point(CurveProfile *profile, CurveProfilePoint *poi
   return true;
 }
 
-/** Removes every point in the widget with the supplied flag set, except for the first and last.
- * \param flag: CurveProfilePoint->flag.
- * \note: Requires curveprofile_update call after. */
+/**
+ * Removes every point in the widget with the supplied flag set, except for the first and last.
+ *
+ * \param flag: #CurveProfilePoint.flag.
+ *
+ * \note Requires #BKE_curveprofile_update call after.
+ */
 void BKE_curveprofile_remove_by_flag(CurveProfile *profile, const short flag)
 {
   int i_old, i_new, n_removed = 0;
@@ -134,10 +140,13 @@ void BKE_curveprofile_remove_by_flag(CurveProfile *profile, const short flag)
   profile->path_len -= n_removed;
 }
 
-/** Adds a new point at the specified location. The choice for which points to place the new vertex
+/**
+ * Adds a new point at the specified location. The choice for which points to place the new vertex
  * between is made by checking which control point line segment is closest to the new point and
  * placing the new vertex in between that segment's points.
- * \note: Requires curveprofile_update call after. */
+ *
+ * \note Requires #BKE_curveprofile_update call after.
+ */
 CurveProfilePoint *BKE_curveprofile_insert(CurveProfile *profile, float x, float y)
 {
   CurveProfilePoint *new_pt = NULL;
@@ -202,7 +211,8 @@ CurveProfilePoint *BKE_curveprofile_insert(CurveProfile *profile, float x, float
 /**
  * Sets the handle type of the selected control points.
  * \param type_1, type_2: Either HD_VECT or HD_AUTO. Handle types for the first and second handles.
- * \note: Requires curveprofile_update call after.
+ *
+ * \note Requires #BKE_curveprofile_update call after.
  */
 void BKE_curveprofile_selected_handle_set(CurveProfile *profile, int type_1, int type_2)
 {
@@ -234,8 +244,11 @@ void BKE_curveprofile_selected_handle_set(CurveProfile *profile, int type_1, int
   }
 }
 
-/** Flips the profile across the diagonal so that its orientation is reversed.
- * \note: Requires curveprofile_update call after.  */
+/**
+ * Flips the profile across the diagonal so that its orientation is reversed.
+ *
+ * \note Requires #BKE_curveprofile_update call after.
+ */
 void BKE_curveprofile_reverse(CurveProfile *profile)
 {
   /* When there are only two points, reversing shouldn't do anything. */
@@ -258,7 +271,9 @@ void BKE_curveprofile_reverse(CurveProfile *profile)
   profile->path = new_pts;
 }
 
-/** Builds a quarter circle profile with space on each side for 'support loops.' */
+/**
+ * Builds a quarter circle profile with space on each side for 'support loops.'
+ */
 static void CurveProfile_build_supports(CurveProfile *profile)
 {
   int n = profile->path_len;
@@ -292,7 +307,10 @@ static void CurveProfile_build_supports(CurveProfile *profile)
   profile->path[n - 1].h2 = HD_VECT;
 }
 
-/** Puts the widget's control points in a step pattern. Uses vector handles for each point. */
+/**
+ * Puts the widget's control points in a step pattern.
+ * Uses vector handles for each point.
+ */
 static void CurveProfile_build_steps(CurveProfile *profile)
 {
   int n, step_x, step_y;
@@ -329,7 +347,9 @@ static void CurveProfile_build_steps(CurveProfile *profile)
   }
 }
 
-/** Shorthand helper function for setting location and interpolation of a point. */
+/**
+ * Shorthand helper function for setting location and interpolation of a point.
+ */
 static void point_init(CurveProfilePoint *point, float x, float y, short flag, char h1, char h2)
 {
   point->x = x;
@@ -339,8 +359,11 @@ static void point_init(CurveProfilePoint *point, float x, float y, short flag, c
   point->h2 = h2;
 }
 
-/** Resets the profile to the current preset.
- * \note: Requires curveprofile_update call after. */
+/**
+ * Resets the profile to the current preset.
+ *
+ * \note Requires #BKE_curveprofile_update call after.
+ */
 void BKE_curveprofile_reset(CurveProfile *profile)
 {
   if (profile->path) {
@@ -429,15 +452,19 @@ void BKE_curveprofile_reset(CurveProfile *profile)
   }
 }
 
-/** Helper for 'curve_profile_create' samples. Returns whether both handles that make up the edge
- * are vector handles. */
+/**
+ * Helper for 'curve_profile_create' samples.
+ * Returns whether both handles that make up the edge are vector handles.
+ */
 static bool is_curved_edge(BezTriple *bezt, int i)
 {
   return (bezt[i].h2 != HD_VECT || bezt[i + 1].h1 != HD_VECT);
 }
 
-/** Used to set bezier handle locations in the sample creation process. Reduced copy of
- * #calchandleNurb_intern code in curve.c. */
+/**
+ * Used to set bezier handle locations in the sample creation process. Reduced copy of
+ * #calchandleNurb_intern code in curve.c.
+ */
 static void calchandle_profile(BezTriple *bezt, const BezTriple *prev, const BezTriple *next)
 {
 #define point_handle1 ((point_loc)-3)
@@ -517,10 +544,12 @@ static void calchandle_profile(BezTriple *bezt, const BezTriple *prev, const Bez
 #undef point_handle2
 }
 
-/** Helper function for 'BKE_CurveProfile_create_samples.' Calculates the angle between the
+/**
+ * Helper function for 'BKE_CurveProfile_create_samples.' Calculates the angle between the
  * handles on the inside of the edge starting at index i. A larger angle means the edge is
  * more curved.
- * \param i_edge: The start index of the edge to calculate the angle for. */
+ * \param i_edge: The start index of the edge to calculate the angle for.
+ */
 static float bezt_edge_handle_angle(const BezTriple *bezt, int i_edge)
 {
   /* Find the direction of the handles that define this edge along the direction of the path. */
@@ -542,7 +571,9 @@ typedef struct {
   float bezt_curvature;
 } CurvatureSortPoint;
 
-/** Helper function for 'BKE_curveprofile_create_samples' for sorting edges based on curvature. */
+/**
+ * Helper function for 'BKE_curveprofile_create_samples' for sorting edges based on curvature.
+ */
 static int sort_points_curvature(const void *in_a, const void *in_b)
 {
   const CurvatureSortPoint *a = (const CurvatureSortPoint *)in_a;
@@ -556,16 +587,19 @@ static int sort_points_curvature(const void *in_a, const void *in_b)
   }
 }
 
-/** Used for sampling curves along the profile's path. Any points more than the number of user-
- * defined points will be evenly distributed among the curved edges. Then the remainders will be
- * distributed to the most curved edges.
+/**
+ * Used for sampling curves along the profile's path. Any points more than the number of
+ * user-defined points will be evenly distributed among the curved edges.
+ * Then the remainders will be distributed to the most curved edges.
+ *
  * \param n_segments: The number of segments to sample along the path. It must be higher than the
- *        number of points used to define the profile (profile->path_len).
+ * number of points used to define the profile (profile->path_len).
  * \param sample_straight_edges: Whether to sample points between vector handle control points. If
- *        this is true and there are only vector edges the straight edges will still be sampled.
+ * this is true and there are only vector edges the straight edges will still be sampled.
  * \param r_samples: An array of points to put the sampled positions. Must have length n_segments.
  * \return r_samples: Fill the array with the sampled locations and if the point corresponds
- *         to a control point, its handle type */
+ * to a control point, its handle type
+ */
 void BKE_curveprofile_create_samples(CurveProfile *profile,
                                      int n_segments,
                                      bool sample_straight_edges,
@@ -726,8 +760,10 @@ void BKE_curveprofile_create_samples(CurveProfile *profile,
   MEM_freeN(n_samples);
 }
 
-/** Creates a higher resolution table by sampling the curved points. This table is used for display
- * and evenly spaced evaluation. */
+/**
+ * Creates a higher resolution table by sampling the curved points.
+ * This table is used for display and evenly spaced evaluation.
+ */
 static void curveprofile_make_table(CurveProfile *profile)
 {
   int n_samples = PROF_N_TABLE(profile->path_len);
@@ -745,8 +781,10 @@ static void curveprofile_make_table(CurveProfile *profile)
   profile->table = new_table;
 }
 
-/** Creates the table of points used for displaying a preview of the sampled segment locations on
- * the widget itself. */
+/**
+ * Creates the table of points used for displaying a preview of the sampled segment locations on
+ * the widget itself.
+ */
 static void CurveProfile_make_segments_table(CurveProfile *profile)
 {
   int n_samples = profile->segments_len;
@@ -771,8 +809,10 @@ static void CurveProfile_make_segments_table(CurveProfile *profile)
   profile->segments = new_table;
 }
 
-/** Sets the default settings and clip range for the profile widget. Does not generate either
- * table. */
+/**
+ * Sets the default settings and clip range for the profile widget.
+ * Does not generate either table.
+ */
 void BKE_curveprofile_set_defaults(CurveProfile *profile)
 {
   profile->flag = PROF_USE_CLIP;
@@ -791,8 +831,10 @@ void BKE_curveprofile_set_defaults(CurveProfile *profile)
   profile->changed_timestamp = 0;
 }
 
-/** Returns a pointer to a newly allocated curve profile, using the given preset.
-  \param preset: Value in eCurveProfilePresets. */
+/**
+ * Returns a pointer to a newly allocated curve profile, using the given preset.
+ * \param preset: Value in #eCurveProfilePresets.
+ */
 struct CurveProfile *BKE_curveprofile_add(int preset)
 {
   CurveProfile *profile = MEM_callocN(sizeof(CurveProfile), "curve profile");
@@ -805,8 +847,10 @@ struct CurveProfile *BKE_curveprofile_add(int preset)
   return profile;
 }
 
-/** Should be called after the widget is changed. Does profile and remove double checks and more
- * importantly, recreates the display / evaluation and segments tables. */
+/**
+ * Should be called after the widget is changed. Does profile and remove double checks and more
+ * importantly, recreates the display / evaluation and segments tables.
+ */
 void BKE_curveprofile_update(CurveProfile *profile, const bool remove_double)
 {
   CurveProfilePoint *points = profile->path;
@@ -873,9 +917,12 @@ void BKE_curveprofile_update(CurveProfile *profile, const bool remove_double)
   }
 }
 
-/** Refreshes the higher resolution table sampled from the input points. A call to this or
- * curveprofile_update is needed before evaluation functions that use the table. Also sets the
- * number of segments used for the display preview of the locations of the sampled points. */
+/**
+ * Refreshes the higher resolution table sampled from the input points. A call to this or
+ * #BKE_curveprofile_update is needed before evaluation functions that use the table.
+ * Also sets the number of segments used for the display preview of the locations
+ * of the sampled points.
+ */
 void BKE_curveprofile_initialize(CurveProfile *profile, short segments_len)
 {
   profile->segments_len = segments_len;
@@ -884,9 +931,12 @@ void BKE_curveprofile_initialize(CurveProfile *profile, short segments_len)
   BKE_curveprofile_update(profile, false);
 }
 
-/** Gives the distance to the next point in the widget's sampled table, in other words the length
+/**
+ * Gives the distance to the next point in the widget's sampled table, in other words the length
  * of the ith edge of the table.
- * \note Requires curveprofile_initialize or curveprofile_update call before to fill table. */
+ *
+ * \note Requires curveprofile_initialize or #BKE_curveprofile_update call before to fill table.
+ */
 static float curveprofile_distance_to_next_table_point(const CurveProfile *profile, int i)
 {
   BLI_assert(i < PROF_N_TABLE(profile->path_len));
@@ -894,8 +944,11 @@ static float curveprofile_distance_to_next_table_point(const CurveProfile *profi
   return len_v2v2(&profile->table[i].x, &profile->table[i + 1].x);
 }
 
-/** Calculates the total length of the profile from the curves sampled in the table.
- * \note Requires curveprofile_initialize or curveprofile_update call before to fill table. */
+/**
+ * Calculates the total length of the profile from the curves sampled in the table.
+ *
+ * \note Requires curveprofile_initialize or #BKE_curveprofile_update call before to fill table.
+ */
 float BKE_curveprofile_total_length(const CurveProfile *profile)
 {
   float total_length = 0;
@@ -905,11 +958,14 @@ float BKE_curveprofile_total_length(const CurveProfile *profile)
   return total_length;
 }
 
-/** Samples evenly spaced positions along the curve profile's table (generated from path). Fills
+/**
+ * Samples evenly spaced positions along the curve profile's table (generated from path). Fills
  * an entire table at once for a speedup if all of the results are going to be used anyway.
- * \note Requires curveprofile_initialize or curveprofile_update call before to fill table.
+ *
+ * \note Requires curveprofile_initialize or #BKE_curveprofile_update call before to fill table.
  * \note Working, but would conflict with "Sample Straight Edges" option, so this is unused for
- * now. */
+ * now.
+ */
 void BKE_curveprofile_create_samples_even_spacing(CurveProfile *profile,
                                                   int n_segments,
                                                   CurveProfilePoint *r_samples)
@@ -964,10 +1020,13 @@ void BKE_curveprofile_create_samples_even_spacing(CurveProfile *profile,
   }
 }
 
-/** Does a single evaluation along the profile's path. Travels down (length_portion * path) length
- * and returns the position at that point.
+/**
+ * Does a single evaluation along the profile's path.
+ * Travels down (length_portion * path) length and returns the position at that point.
+ *
  * \param length_portion: The portion (0 to 1) of the path's full length to sample at.
- * \note Requires curveprofile_initialize or curveprofile_update call before to fill table */
+ * \note Requires curveprofile_initialize or #BKE_curveprofile_update call before to fill table.
+ */
 void BKE_curveprofile_evaluate_length_portion(const CurveProfile *profile,
                                               float length_portion,
                                               float *x_out,
index aac3e8cc7fc71f0022caff0c0762e227e94478c1..47b6fbfb4f8e44de6d81f584a63139f1c5c9fbec 100644 (file)
@@ -1634,8 +1634,10 @@ bool BKE_vfont_to_curve_nubase(Object *ob, int mode, ListBase *r_nubase)
   return BKE_vfont_to_curve_ex(ob, ob->data, mode, r_nubase, NULL, NULL, NULL, NULL);
 }
 
-/** Warning: expects to have access to evaluated data
- * (i.e. passed object should be evaluated one...). */
+/**
+ * Warning: expects to have access to evaluated data
+ * (i.e. passed object should be evaluated one...).
+ */
 bool BKE_vfont_to_curve(Object *ob, int mode)
 {
   Curve *cu = ob->data;
index c51668ea68c714dc5acdae111f22c8d23b871cc1..d0da5c6c0f1a07f2daf8cbf1935ee22c37944e8d 100644 (file)
@@ -1140,7 +1140,8 @@ int BKE_gpencil_object_material_ensure(Main *bmain, Object *ob, Material *materi
   return index;
 }
 
-/** Creates a new gpencil material and assigns it to object.
+/**
+ * Creates a new gpencil material and assigns it to object.
  *
  * \param *r_index: value is set to zero based index of the new material if r_index is not NULL
  */
index 90dba4bc737a8dcb48e6ec4272532d2414362044..7b8a0a8894f5ca3d5d72538ed67afe7475dbad48 100644 (file)
@@ -468,8 +468,10 @@ void BKE_previewimg_cached_release(const char *name)
   BKE_previewimg_cached_release_pointer(prv);
 }
 
-/** Handle deferred (lazy) loading/generation of preview image, if needed.
- * For now, only used with file thumbnails. */
+/**
+ * Handle deferred (lazy) loading/generation of preview image, if needed.
+ * For now, only used with file thumbnails.
+ */
 void BKE_previewimg_ensure(PreviewImage *prv, const int size)
 {
   if ((prv->tag & PRV_TAG_DEFFERED) != 0) {
index 9a38f348361a892233521dc2cc9830d9061f990c..6e8677b5422ef92647e3e8a3b28ab80959be9ab5 100644 (file)
@@ -2256,7 +2256,8 @@ void BKE_keyblock_update_from_offset(Object *ob, KeyBlock *kb, const float (*ofs
 
 /* ==========================================================*/
 
-/** Move shape key from org_index to new_index. Safe, clamps index to valid range,
+/**
+ * Move shape key from org_index to new_index. Safe, clamps index to valid range,
  * updates reference keys, the object's active shape index,
  * the 'frame' value in case of absolute keys, etc.
  * Note indices are expected in real values (not 'fake' shapenr +1 ones).
index 909db9c7b52fad74e5a0d50ae499e6429a84779a..e312522b508b73b763c1583421bad4fffc8233ce 100644 (file)
@@ -797,8 +797,10 @@ bool BKE_id_copy(Main *bmain, const ID *id, ID **newid)
   return BKE_id_copy_ex(bmain, id, newid, LIB_ID_COPY_DEFAULT);
 }
 
-/** Does a mere memory swap over the whole IDs data (including type-specific memory).
- * \note Most internal ID data itself is not swapped (only IDProperties are). */
+/**
+ * Does a mere memory swap over the whole IDs data (including type-specific memory).
+ * \note Most internal ID data itself is not swapped (only IDProperties are).
+ */
 void BKE_id_swap(Main *bmain, ID *id_a, ID *id_b)
 {
   BLI_assert(GS(id_a->name) == GS(id_b->name));
@@ -1380,9 +1382,11 @@ void BKE_libblock_init_empty(ID *id)
   }
 }
 
-/** Generic helper to create a new empty data-block of given type in given \a bmain database.
+/**
+ * Generic helper to create a new empty data-block of given type in given \a bmain database.
  *
- * \param name: can be NULL, in which case we get default name for this ID type. */
+ * \param name: can be NULL, in which case we get default name for this ID type.
+ */
 void *BKE_id_new(Main *bmain, const short type, const char *name)
 {
   BLI_assert(bmain != NULL);
@@ -1936,7 +1940,8 @@ static void library_make_local_copying_check(ID *id,
   BLI_gset_remove(loop_tags, id, NULL);
 }
 
-/** Make linked data-blocks local.
+/**
+ * Make linked data-blocks local.
  *
  * \param bmain: Almost certainly global main.
  * \param lib: If not NULL, only make local data-blocks from this library.
@@ -2363,8 +2368,10 @@ void BKE_id_tag_clear_atomic(ID *id, int tag)
   atomic_fetch_and_and_int32(&id->tag, ~tag);
 }
 
-/** Check that given ID pointer actually is in G_MAIN.
- * Main intended use is for debug asserts in places we cannot easily get rid of G_Main... */
+/**
+ * Check that given ID pointer actually is in G_MAIN.
+ * Main intended use is for debug asserts in places we cannot easily get rid of G_Main...
+ */
 bool BKE_id_is_in_global_main(ID *id)
 {
   /* We do not want to fail when id is NULL here, even though this is a bit strange behavior...
index ae6d1c26a2b6f34e627a27e556187bb0e3ccb3d9..2e958c8a5787848a425a24bb4d1f3cc56dd05fba 100644 (file)
@@ -221,7 +221,8 @@ ID *BKE_override_library_create_from_id(Main *bmain, ID *reference_id, const boo
   return local_id;
 }
 
-/** Create overridden local copies of all tagged data-blocks in given Main.
+/**
+ * Create overridden local copies of all tagged data-blocks in given Main.
  *
  * \note Set id->newid of overridden libs with newly created overrides,
  * caller is responsible to clean those pointers before/after usage as needed.
index be283c68911941d48ab45ce571b3481bb9ddb158..e1b3212a92cb436691a702275309542a06ebddc2 100644 (file)
@@ -636,7 +636,8 @@ void BKE_libblock_unlink(Main *bmain,
   BKE_main_unlock(bmain);
 }
 
-/** Similar to libblock_remap, but only affects IDs used by given \a idv ID.
+/**
+ * Similar to libblock_remap, but only affects IDs used by given \a idv ID.
  *
  * \param old_idv: Unlike BKE_libblock_remap, can be NULL,
  * in which case all ID usages by given \a idv will be cleared.
index b127d5d4d0edd338978fde60b838ad2a7646c53c..c5cb95927ec591688432a32d18e5f303236cb364 100644 (file)
@@ -178,7 +178,8 @@ MetaElem *BKE_mball_element_add(MetaBall *mb, const int type)
 
   return ml;
 }
-/** Compute bounding box of all MetaElems/MetaBalls.
+/**
+ * Compute bounding box of all MetaElems/MetaBalls.
  *
  * Bounding box is computed from polygonized surface. Object *ob is
  * basic MetaBall (usually with name Meta). All other MetaBalls (with
index 7a1dcb4a5fd46f04e01912b7c73c1f4acbd05814..2b3051b766a3e79835181854a54f3985c1cc8cf4 100644 (file)
@@ -915,7 +915,8 @@ static void mesh_edges_sharp_tag(LoopSplitTaskDataCommon *data,
   }
 }
 
-/** Define sharp edges as needed to mimic 'autosmooth' from angle threshold.
+/**
+ * Define sharp edges as needed to mimic 'autosmooth' from angle threshold.
  *
  * Used when defining an empty custom loop normals data layer,
  * to keep same shading as with autosmooth!
index b50e152527e75d00824e5f89613c9c534751b538..2f7bd27445affaf3115eece7f0bc9ad2a436b158 100644 (file)
@@ -1462,7 +1462,8 @@ Object *BKE_object_copy(Main *bmain, const Object *ob)
   return ob_copy;
 }
 
-/** Perform deep-copy of object and its 'children' data-blocks (obdata, materials, actions, etc.).
+/**
+ * Perform deep-copy of object and its 'children' data-blocks (obdata, materials, actions, etc.).
  *
  * \param dupflag: Controls which sub-data are also duplicated
  * (see #eDupli_ID_Flags in DNA_userdef_types.h).
index 2753cbd9be2691ea795dc0513a19361fa775938b..9dcebbba56ebd47ce5f96e502a3655207b14b58b 100644 (file)
@@ -1433,7 +1433,8 @@ void BKE_scene_graph_update_for_newframe(Depsgraph *depsgraph, Main *bmain)
   }
 }
 
-/** Ensures given scene/view_layer pair has a valid, up-to-date depsgraph.
+/**
+ * Ensures given scene/view_layer pair has a valid, up-to-date depsgraph.
  *
  * \warning Sets matching depsgraph as active,
  * so should only be called from the active editing context (usually, from operators).
index 1835fb2a52346bc8d998c4b90b34f5e3c0046a00..5e19a60dfa27756a0bc3b953e0c4d27f706a2f44 100644 (file)
@@ -756,7 +756,7 @@ ARegion *BKE_screen_find_region_xy(bScreen *sc, const int regiontype, int x, int
 }
 
 /**
- * \note, ideally we can get the area from the context,
+ * \note Ideally we can get the area from the context,
  * there are a few places however where this isn't practical.
  */
 ScrArea *BKE_screen_find_area_from_space(struct bScreen *sc, SpaceLink *sl)
index ff92704e2d14edfc86eec797d6ec29a3be125c56..a02ff98a38a79bdcff61ebb563b23cddf7c52c7d 100644 (file)
@@ -85,7 +85,9 @@ static const char *STUDIOLIGHT_MATCAP_DEFAULT = "basic_1.exr";
 
 /* ITER MACRO */
 
-/** Iter on all pixel giving texel center position and pixel pointer.
+/**
+ * Iter on all pixel giving texel center position and pixel pointer.
+ *
  * Arguments
  *   type : type of src.
  *   src : source buffer.
index ecae1650a51dc1dcc735c3dc0ef6575d027d28f5..36a58a6ca02cebce6bd1d203e09211d4a2d21e52 100644 (file)
 /** Make sure all ID's created at the point we add an undo step that uses ID's. */
 #define WITH_GLOBAL_UNDO_ENSURE_UPDATED
 
-/** Make sure we don't apply edits on top of a newer memfile state, see: T56163.
- * \note Keep an eye on this, could solve differently. */
+/**
+ * Make sure we don't apply edits on top of a newer memfile state, see: T56163.
+ * \note Keep an eye on this, could solve differently.
+ */
 #define WITH_GLOBAL_UNDO_CORRECT_ORDER
 
 /** We only need this locally. */
index 57e1790fdfd0cf2ddbec5d4b908a0e5b36a8c2ad..5b85711f8ac41bbc4e9d5e3f6c8a51934432b0bf 100644 (file)
@@ -42,7 +42,8 @@
 
 /** \} */
 
-/** BLI_array.c
+/**
+ * BLI_array.c
  *
  * Doing the realloc in a macro isn't so simple,
  * so use a function the macros can use.
index eec4e8854935f394feeb976c09bbb19ab795d00f..be2b18b05fd83c317108a1d70242dfc255b5c11b 100644 (file)
@@ -72,9 +72,9 @@ void BLI_array_frand(float *ar, int count, unsigned int seed);
 /** Return a pseudo-random (hash) float from an integer value */
 float BLI_hash_frand(unsigned int seed) ATTR_WARN_UNUSED_RESULT;
 
-/** Shuffle an array randomly using the given seed.
- * contents. This routine does not use nor modify
- * the state of the BLI random number generator.
+/**
+ * Shuffle an array randomly using the given seed contents.
+ * This routine does not use nor modify the state of the BLI random number generator.
  */
 void BLI_array_randomize(void *data,
                          unsigned int elem_size,
index 2a02eb380b5804e4460f78ad3e414852facc5d45..ef210a82a659116ca2ce86c0fcca9ad19972e7c6 100644 (file)
@@ -24,7 +24,7 @@
  * \ingroup bli
  */
 
-/** find the index number of a voxel, given x/y/z integer coords and resolution vector */
+/** Find the index number of a voxel, given x/y/z integer coords and resolution vector. */
 
 #define BLI_VOXEL_INDEX(x, y, z, res) \
   ((int64_t)(x) + (int64_t)(y) * (int64_t)(res)[0] + \
index 9c1e52b53a45ea52d4514f08258847b6028a74f2..27f7a2a44309951d7b6d83a8061247cc95a9c465 100644 (file)
@@ -115,8 +115,10 @@ static void validate_face_centroid(SymEdge *se);
 static void validate_cdt(CDT_state *cdt, bool check_all_tris);
 #endif
 
-/** return 1 if a,b,c forms CCW angle, -1 if a CW angle, 0 if straight.
- * For straight test, allow b to be withing eps of line. */
+/**
+ * Return 1 if a,b,c forms CCW angle, -1 if a CW angle, 0 if straight.
+ * For straight test, allow b to be withing eps of line.
+ */
 static int CCW_test(const double a[2], const double b[2], const double c[2], const double eps)
 {
   double det;
@@ -902,7 +904,8 @@ static LocateResult locate_point(CDT_state *cdt, const double p[2])
   return lr;
 }
 
-/** Return true if circumcircle(v1, v2, v3) does not contain p.
+/**
+ * Return true if circumcircle(v1, v2, v3) does not contain p.
  * To avoid possible infinite flip loops, we will say true even if p is inside the circle
  * but less than epsilon from the boundary; or if v1, v2, v3, form a straight line.
  */
index f9e9b3bfbf9ac7873b036c20d99c0063fe807653..5ec1c91a735a7021f94ee80c37c4a364e6adbca9 100644 (file)
@@ -94,8 +94,9 @@ struct md5_ctx {
  * (RFC 1321, 3.1: Step 1) */
 static const unsigned char fillbuf[64] = {0x80, 0 /* , 0, 0, ...  */};
 
-/** Initialize structure containing state of computation.
- *  (RFC 1321, 3.3: Step 3)
+/**
+ * Initialize structure containing state of computation.
+ * (RFC 1321, 3.3: Step 3)
  */
 static void md5_init_ctx(struct md5_ctx *ctx)
 {
@@ -283,8 +284,9 @@ static void *md5_read_ctx(const struct md5_ctx *ctx, void *resbuf)
 
 /* Top level public functions. */
 
-/** Compute MD5 message digest for bytes read from 'stream'.
- *  The resulting message digest number will be written into the 16 bytes beginning at 'resblock'.
+/**
+ * Compute MD5 message digest for bytes read from 'stream'.
+ * The resulting message digest number will be written into the 16 bytes beginning at 'resblock'.
  * \return Non-zero if an error occurred.
  */
 int BLI_hash_md5_stream(FILE *stream, void *resblock)
index 32e8a4e90f53c11bcb2220f17ce4e86fbcaaa5ee..404e136a0a6cc350c0d4c22e073dd8d7899fbc2a 100644 (file)
@@ -58,8 +58,10 @@ struct KDTree {
 
 #define KD_NODE_UNSET ((uint)-1)
 
-/** When set we know all values are unbalanced,
- * otherwise clear them when re-balancing: see T62210. */
+/**
+ * When set we know all values are unbalanced,
+ * otherwise clear them when re-balancing: see T62210.
+ */
 #define KD_NODE_ROOT_IS_INIT ((uint)-2)
 
 /* -------------------------------------------------------------------- */
index 0309876d8fb83932595313679a697896b91c7f15..4c86b9d3396fadeeff54edb37d67ee07e9cf230a 100644 (file)
@@ -526,15 +526,19 @@ MINLINE int signum_i(float a)
   }
 }
 
-/** Returns number of (base ten) *significant* digits of integer part of given float
- * (negative in case of decimal-only floats, 0.01 returns -1 e.g.). */
+/**
+ * Returns number of (base ten) *significant* digits of integer part of given float
+ * (negative in case of decimal-only floats, 0.01 returns -1 e.g.).
+ */
 MINLINE int integer_digits_f(const float f)
 {
   return (f == 0.0f) ? 0 : (int)floor(log10(fabs(f))) + 1;
 }
 
-/** Returns number of (base ten) *significant* digits of integer part of given double
- * (negative in case of decimal-only floats, 0.01 returns -1 e.g.). */
+/**
+ * Returns number of (base ten) *significant* digits of integer part of given double
+ * (negative in case of decimal-only floats, 0.01 returns -1 e.g.).
+ */
 MINLINE int integer_digits_d(const double d)
 {
   return (d == 0.0) ? 0 : (int)floor(log10(fabs(d))) + 1;
index 67ef4d57b4b648d67868028d587183cd7cf509df..27715ed49b5e8106e46407b30477e5602b5228d0 100644 (file)
@@ -2996,8 +2996,9 @@ int isect_line_line_v3(const float v1[3],
   return isect_line_line_epsilon_v3(v1, v2, v3, v4, r_i1, r_i2, epsilon);
 }
 
-/** Intersection point strictly between the two lines
- * \return false when no intersection is found
+/**
+ * Intersection point strictly between the two lines
+ * \return false when no intersection is found.
  */
 bool isect_line_line_strict_v3(const float v1[3],
                                const float v2[3],
@@ -3188,7 +3189,7 @@ bool isect_ray_aabb_v3(const struct IsectRayAABB_Precalc *data,
  * Test a bounding box (AABB) for ray intersection.
  * Assumes the ray is already local to the boundbox space.
  *
- * \note: \a direction should be normalized
+ * \note \a direction should be normalized
  * if you intend to use the \a tmin or \a tmax distance results!
  */
 bool isect_ray_aabb_v3_simple(const float orig[3],
@@ -3791,7 +3792,7 @@ bool barycentric_coords_v2(
 }
 
 /**
- * \note: using #cross_tri_v2 means locations outside the triangle are correctly weighted
+ * \note Using #cross_tri_v2 means locations outside the triangle are correctly weighted.
  *
  * \note This is *exactly* the same calculation as #resolve_tri_uv_v2,
  * although it has double precision and is used for texture baking, so keep both.
index 48884082dd899eed624209f878fc61b1278cf3ca..5118d8a698ed834afa983211bfe306f0a8380cc8 100644 (file)
@@ -1964,8 +1964,10 @@ void mat4_to_size(float size[3], const float mat[4][4])
   size[2] = len_v3(mat[2]);
 }
 
-/** Extract scale factors from the matrix, with correction to ensure
- *  exact volume in case of a sheared matrix. */
+/**
+ * Extract scale factors from the matrix, with correction to ensure
+ * exact volume in case of a sheared matrix.
+ */
 void mat4_to_size_fix_shear(float size[3], const float mat[4][4])
 {
   mat4_to_size(size, mat);
index 37c0c05b0614eead3d0f9e1f001d652dd36ebc3d..94f0f523c6e6ec3fc93ffa79687cd783fc23fe20 100644 (file)
@@ -77,7 +77,7 @@ void mul_qt_qtqt(float q[4], const float q1[4], const float q2[4])
 }
 
 /**
- * \note:
+ * \note
  * Assumes a unit quaternion?
  *
  * in fact not, but you may want to use a unit quat, read on...
@@ -93,7 +93,7 @@ void mul_qt_qtqt(float q[4], const float q1[4], const float q2[4])
  * For people used to python mathutils, its like:
  * def mul_qt_v3(q, v): (q * Quaternion((0.0, v[0], v[1], v[2])) * q.conjugated())[1:]
  *
- * \note: multiplying by 3x3 matrix is ~25% faster.
+ * \note Multiplying by 3x3 matrix is ~25% faster.
  */
 void mul_qt_v3(const float q[4], float v[3])
 {
index 725b6f8937a57c3f3a71ae4b4570b4b6bcb03875..dff1f77c1abb96a7b9e57b8fcc69d50555a21a7a 100644 (file)
 
 #ifdef WIN32
 
-/** Return true if the path is absolute ie starts with a drive specifier
- * (eg A:\) or is a UNC path. */
+/**
+ * Return true if the path is absolute ie starts with a drive specifier
+ * (eg A:\) or is a UNC path.
+ */
 static bool BLI_path_is_abs(const char *name);
 
 #endif /* WIN32 */
@@ -444,8 +446,10 @@ static int BLI_path_unc_prefix_len(const char *path)
 
 #if defined(WIN32)
 
-/** Return true if the path is absolute ie starts with a drive specifier
- * (eg A:\) or is a UNC path. */
+/**
+ * Return true if the path is absolute ie starts with a drive specifier
+ * (eg A:\) or is a UNC path.
+ */
 static bool BLI_path_is_abs(const char *name)
 {
   return (name[1] == ':' && (name[2] == '\\' || name[2] == '/')) || BLI_path_is_unc(name);
index 68b30912041b3a7038fff0c77d87a6391f1f0249..f795783d161574561b2fb35d89385db19da834ec 100644 (file)
@@ -363,7 +363,7 @@ BMFace *BM_face_copy(
  * only create the face, since this calloc's the length is initialized to 0,
  * leave adding loops to the caller.
  *
- * \note, caller needs to handle customdata.
+ * \note Caller needs to handle customdata.
  */
 BLI_INLINE BMFace *bm_face_create__internal(BMesh *bm)
 {
index 4790c811e56eeeddd3c7659a7438293d24a4b2fd..15de281ded47450113611187c537a5118c8744f6 100644 (file)
@@ -1108,7 +1108,8 @@ void BM_loops_calc_normal_vcos(BMesh *bm,
   }
 }
 
-/** Define sharp edges as needed to mimic 'autosmooth' from angle threshold.
+/**
+ * Define sharp edges as needed to mimic 'autosmooth' from angle threshold.
  *
  * Used when defining an empty custom loop normals data layer,
  * to keep same shading as with autosmooth!
index a193275ef5258129237bc080fffc805626338165..f93d33bb05fe97b69cd65621cfb54d83a8bd60eb 100644 (file)
@@ -212,7 +212,7 @@ static GSet *bm_edgering_pair_calc(BMesh *bm, ListBase *eloops_rim)
    *       - use the edge-verts and (vert -> eloop) map
    *         to create a pair of eloop pointers, add these to a hash.
    *
-   * \note, each loop pair will be found twice.
+   * \note Each loop pair will be found twice.
    * could sort and optimize this but not really so important.
    */
 
index e2f098d72f3c7397398f089b6e41208016122dbd..9cc645f7a3a2acf53aced6820125ffaff0e6f4e5 100644 (file)
@@ -161,10 +161,12 @@ typedef struct Profile {
 #define PRO_LINE_R 1.0f
 #define PRO_SQUARE_IN_R 0.0f
 
-/** The un-transformed 2D storage of profile vertex locations. Also for non-custom profiles
+/**
+ * The un-transformed 2D storage of profile vertex locations. Also for non-custom profiles
  * this serves as a cache for the results of the expensive calculation of u parameter values to
  * get even spacing on superellipse for current BevelParams seg
- * and pro_super_r. */
+ * and pro_super_r.
+ */
 typedef struct ProfileSpacing {
   /** The profile's seg+1 x values */
   double *xvals;
@@ -3022,14 +3024,18 @@ static bool adjust_the_cycle_or_chain_fast(BoundVert *vstart, int np, bool iscyc
 }
 #endif
 
-/** Helper function to return the next Beveled EdgeHalf along a path.
- * \param toward_bv Whether the direction to travel points toward or away from the BevVert
- *        connected to the current EdgeHalf
- * \param r_bv The BevVert connected to the EdgeHalf-- updated if we're traveling to the other
- *        EdgeHalf of an original edge
+/**
+ * Helper function to return the next Beveled EdgeHalf along a path.
+ *
+ * \param toward_bv: Whether the direction to travel points toward or away from the BevVert
+ * connected to the current EdgeHalf.
+ * \param r_bv: The BevVert connected to the EdgeHalf -- updated if we're traveling to the other
+ * EdgeHalf of an original edge.
+ *
  * \note This only returns the most parallel edge if it's the most parallel by
  * at least 10 degrees. This is a somewhat arbitrary choice, but it makes sure that consistent
- * orientation paths only continue in obvious ways. */
+ * orientation paths only continue in obvious ways.
+ */
 static EdgeHalf *next_edgehalf_bev(BevelParams *bp,
                                    EdgeHalf *start_edge,
                                    bool toward_bv,
@@ -3115,10 +3121,12 @@ static EdgeHalf *next_edgehalf_bev(BevelParams *bp,
   }
 }
 
-/** Starting along any beveled edge, travel along the chain / cycle of beveled edges including that
+/**
+ * Starting along any beveled edge, travel along the chain / cycle of beveled edges including that
  * edge, marking consistent profile orientations along the way. Orientations are marked by setting
  * whether the BoundVert that contains each profile's information is the side of the profile's
- * start or not. */
+ * start or not.
+ */
 static void regularize_profile_orientation(BevelParams *bp, BMEdge *bme)
 {
   BevVert *start_bv;
@@ -3166,10 +3174,12 @@ static void regularize_profile_orientation(BevelParams *bp, BMEdge *bme)
 }
 
 #ifdef DEBUG_PROFILE_ORIENTATION_DRAW
-/** Draws markers on beveled edges showing the side that the profile starts on. A sphere shows
+/**
+ * Draws markers on beveled edges showing the side that the profile starts on. A sphere shows
  * the start side of the profile where it starts, and the lines connected to the sphere show which
  * edge the orientation corresponds to.
- * \note Only drawn while bevel is calculating, the debug geometry is not persistent. */
+ * \note Only drawn while bevel is calculating, the debug geometry is not persistent.
+ */
 static void debug_draw_profile_orientation(BevelParams *bp, BMesh *bm)
 {
   BMIter iter;
@@ -4365,9 +4375,11 @@ static void snap_to_pipe_profile(BoundVert *vpipe, bool midline, float co[3])
   }
 }
 
-/** See pipe_test for conditions that make 'pipe'; vpipe is the return value from that.
+/**
+ * See pipe_test for conditions that make 'pipe'; vpipe is the return value from that.
  * We want to make an ADJ mesh but then snap the vertices to the profile in a plane
- * perpendicular to the pipes. */
+ * perpendicular to the pipes.
+ */
 static VMesh *pipe_adj_vmesh(BevelParams *bp, BevVert *bv, BoundVert *vpipe)
 {
 #ifdef DEBUG_CUSTOM_PROFILE_PIPE
@@ -5066,14 +5078,17 @@ static void bevel_build_rings(BevelParams *bp, BMesh *bm, BevVert *bv, BoundVert
   }
 }
 
-/** Builds the vertex mesh when the vertex mesh type is set to "cut off" with a face closing
- * off each incoming edge's profile */
-/* HANS-TODO: Make cutoff VMesh work with outer miter != sharp. This should be possible but there
+/**
+ * Builds the vertex mesh when the vertex mesh type is set to "cut off" with a face closing
+ * off each incoming edge's profile.
+ *
+ * TODO(Hans): Make cutoff VMesh work with outer miter != sharp. This should be possible but there
  * are two problems currently:
  *  - Miter profiles don't have plane_no filled, so down direction is incorrect.
  *  - Indexing profile points of miters with (i, 0, k) seems to return zero except for the first
- *    and last profile point. */
-/* HANS-TODO: Use repface / edge arrays for UV interpolation properly. */
+ *    and last profile point.
+ * TODO(Hans): Use repface / edge arrays for UV interpolation properly.
+ */
 static void bevel_build_cutoff(BevelParams *bp, BMesh *bm, BevVert *bv)
 {
 #ifdef DEBUG_CUSTOM_PROFILE_CUTOFF
@@ -6905,9 +6920,11 @@ static void find_even_superellipse_chords(int n, float r, double *xvals, double
   find_even_superellipse_chords_general(n, r, xvals, yvals);
 }
 
-/** Find the profile's "fullness," which is the fraction of the space it takes up way from the
+/**
+ * Find the profile's "fullness," which is the fraction of the space it takes up way from the
  * boundvert's centroid to the original vertex for a non-custom profile, or in the case of a
- * custom profile, the average "height" of the profile points along its centerline. */
+ * custom profile, the average "height" of the profile points along its centerline.
+ */
 static float find_profile_fullness(BevelParams *bp)
 {
   float fullness;
@@ -6958,14 +6975,16 @@ static float find_profile_fullness(BevelParams *bp)
   return fullness;
 }
 
-/** Fills the ProfileSpacing struct with the 2D coordinates for the profile's vertices.
+/**
+ * Fills the ProfileSpacing struct with the 2D coordinates for the profile's vertices.
  * The superellipse used for multisegment profiles does not have a closed-form way
  * to generate evenly spaced points along an arc. We use an expensive search procedure
  * to find the parameter values that lead to bp->seg even chords.
  * We also want spacing for a number of segments that is a power of 2 >= bp->seg (but at least 4).
  * Use doubles because otherwise we cannot come close to float precision for final results.
+ *
  * \param pro_spacing: The struct to fill. Changes depending on whether there needs
         to be a separate miter profile. */
* to be a separate miter profile. */
 static void set_profile_spacing(BevelParams *bp, ProfileSpacing *pro_spacing, bool custom)
 {
   int seg, seg_2;
index 198b4c8e76b9951949c0673e55ba1aaf93567b21..56febf12e71a617b120b31d70621df5da6abaf10 100644 (file)
 #endif
 
 #define BOUNDARY_PRESERVE_WEIGHT 100.0f
-/** Uses double precision, impacts behavior on near-flat surfaces,
- * cane give issues with very small faces. 1e-2 is too big, see: T48154. */
+/**
+ * Uses double precision, impacts behavior on near-flat surfaces,
+ * cane give issues with very small faces. 1e-2 is too big, see: T48154.
+ */
 #define OPTIMIZE_EPS 1e-8
 #define COST_INVALID FLT_MAX
 
index 9d838406101b639ae7b2cc64852a918d5a471944..30e41a8d72035c15c8dd76082f32cda659b28cda 100644 (file)
@@ -351,8 +351,10 @@ std::string DocumentImporter::get_import_version(const COLLADAFW::FileInfo *asse
   return "";
 }
 
-/** When this method is called, the writer must write the global document asset.
- * \return The writer should return true, if writing succeeded, false otherwise.*/
+/**
+ * When this method is called, the writer must write the global document asset.
+ * \return The writer should return true, if writing succeeded, false otherwise.
+ */
 bool DocumentImporter::writeGlobalAsset(const COLLADAFW::FileInfo *asset)
 {
   unit_converter.read_asset(asset);
@@ -361,8 +363,10 @@ bool DocumentImporter::writeGlobalAsset(const COLLADAFW::FileInfo *asset)
   return true;
 }
 
-/** When this method is called, the writer must write the scene.
- * \return The writer should return true, if writing succeeded, false otherwise.*/
+/**
+ * When this method is called, the writer must write the scene.
+ * \return The writer should return true, if writing succeeded, false otherwise.
+ */
 bool DocumentImporter::writeScene(const COLLADAFW::Scene *scene)
 {
   /* XXX could store the scene id, but do nothing for now */
@@ -742,9 +746,11 @@ bool DocumentImporter::writeVisualScene(const COLLADAFW::VisualScene *visualScen
   return true;
 }
 
-/** When this method is called, the writer must handle all nodes contained in the
+/**
+ * When this method is called, the writer must handle all nodes contained in the
  * library nodes.
- * \return The writer should return true, if writing succeeded, false otherwise.*/
+ * \return The writer should return true, if writing succeeded, false otherwise.
+ */
 bool DocumentImporter::writeLibraryNodes(const COLLADAFW::LibraryNodes *libraryNodes)
 {
   if (mImportStage == Fetching_Controller_data) {
@@ -764,8 +770,10 @@ bool DocumentImporter::writeLibraryNodes(const COLLADAFW::LibraryNodes *libraryN
   return true;
 }
 
-/** When this method is called, the writer must write the geometry.
- * \return The writer should return true, if writing succeeded, false otherwise.*/
+/**
+ * When this method is called, the writer must write the geometry.
+ * \return The writer should return true, if writing succeeded, false otherwise.
+ */
 bool DocumentImporter::writeGeometry(const COLLADAFW::Geometry *geom)
 {
   if (mImportStage == Fetching_Controller_data) {
@@ -775,8 +783,10 @@ bool DocumentImporter::writeGeometry(const COLLADAFW::Geometry *geom)
   return mesh_importer.write_geometry(geom);
 }
 
-/** When this method is called, the writer must write the material.
- * \return The writer should return true, if writing succeeded, false otherwise.*/
+/**
+ * When this method is called, the writer must write the material.
+ * \return The writer should return true, if writing succeeded, false otherwise.
+ */
 bool DocumentImporter::writeMaterial(const COLLADAFW::Material *cmat)
 {
   if (mImportStage == Fetching_Controller_data) {
@@ -816,9 +826,10 @@ void DocumentImporter::write_profile_COMMON(COLLADAFW::EffectCommon *ef, Materia
   matNode.set_reflective(ef->getReflective());
 }
 
-/** When this method is called, the writer must write the effect.
- * \return The writer should return true, if writing succeeded, false otherwise.*/
-
+/**
+ * When this method is called, the writer must write the effect.
+ * \return The writer should return true, if writing succeeded, false otherwise.
+ */
 bool DocumentImporter::writeEffect(const COLLADAFW::Effect *effect)
 {
   if (mImportStage == Fetching_Controller_data) {
@@ -854,8 +865,10 @@ bool DocumentImporter::writeEffect(const COLLADAFW::Effect *effect)
   return true;
 }
 
-/** When this method is called, the writer must write the camera.
- * \return The writer should return true, if writing succeeded, false otherwise.*/
+/**
+ * When this method is called, the writer must write the camera.
+ * \return The writer should return true, if writing succeeded, false otherwise.
+ */
 bool DocumentImporter::writeCamera(const COLLADAFW::Camera *camera)
 {
   if (mImportStage == Fetching_Controller_data) {
@@ -965,8 +978,10 @@ bool DocumentImporter::writeCamera(const COLLADAFW::Camera *camera)
   return true;
 }
 
-/** When this method is called, the writer must write the image.
- * \return The writer should return true, if writing succeeded, false otherwise.*/
+/**
+ * When this method is called, the writer must write the image.
+ * \return The writer should return true, if writing succeeded, false otherwise.
+ */
 bool DocumentImporter::writeImage(const COLLADAFW::Image *image)
 {
   if (mImportStage == Fetching_Controller_data) {
@@ -1003,8 +1018,10 @@ bool DocumentImporter::writeImage(const COLLADAFW::Image *image)
   return true;
 }
 
-/** When this method is called, the writer must write the light.
- * \return The writer should return true, if writing succeeded, false otherwise.*/
+/**
+ * When this method is called, the writer must write the light.
+ * \return The writer should return true, if writing succeeded, false otherwise.
+ */
 bool DocumentImporter::writeLight(const COLLADAFW::Light *light)
 {
   if (mImportStage == Fetching_Controller_data) {
@@ -1188,8 +1205,10 @@ bool DocumentImporter::writeAnimationClip(const COLLADAFW::AnimationClip *animat
 }
 #endif
 
-/** When this method is called, the writer must write the skin controller data.
- * \return The writer should return true, if writing succeeded, false otherwise.*/
+/**
+ * When this method is called, the writer must write the skin controller data.
+ * \return The writer should return true, if writing succeeded, false otherwise.
+ */
 bool DocumentImporter::writeSkinControllerData(const COLLADAFW::SkinControllerData *skin)
 {
   return armature_importer.write_skin_controller_data(skin);
index 65c7429bb687ff7e9405d08c873c2202caee22d7..deb60836177be2b99b29bcbdcebcec9cd7482e91 100644 (file)
@@ -198,13 +198,13 @@ void ExecutionGroup::execute(ExecutionSystem *graph)
   const bNodeTree *bTree = context.getbNodeTree();
   if (this->m_width == 0 || this->m_height == 0) {
     return;
-  }  /// \note: break out... no pixels to calculate.
+  }  /// \note Break out... no pixels to calculate.
   if (bTree->test_break && bTree->test_break(bTree->tbh)) {
     return;
-  }  /// \note: early break out for blur and preview nodes
+  }  /// \note Early break out for blur and preview nodes.
   if (this->m_numberOfChunks == 0) {
     return;
-  }  /// \note: early break out
+  }  /// \note Early break out.
   unsigned int chunkNumber;
 
   this->m_executionStartTime = PIL_check_seconds_timer();
index b4d6cc0ff606db06f8080a1dd7d6a0ff7b183eaa..6640f144518fa78baa2292f89f72f9cb2584e466 100644 (file)
@@ -188,7 +188,7 @@ NodeOutput *NodeGraph::find_output(const NodeRange &node_range, bNodeSocket *b_s
 
 void NodeGraph::add_bNodeLink(const NodeRange &node_range, bNodeLink *b_nodelink)
 {
-  /// \note: ignore invalid links
+  /// \note Ignore invalid links.
   if (!(b_nodelink->flag & NODE_LINK_VALID)) {
     return;
   }
index 087b3dda48d578840c2aceb25000f43f2e94b743..b005149c839b50fd7c97c82f9bb87de6b7d93cbb 100644 (file)
@@ -36,8 +36,9 @@ class Node;
 class NodeInput;
 class NodeOutput;
 
-/** Internal representation of DNA node data.
- *  This structure is converted into operations by \a NodeCompiler.
+/**
+ * Internal representation of DNA node data.
+ * This structure is converted into operations by \a NodeCompiler.
  */
 class NodeGraph {
  public:
index 3774054659ddcbf7d67c2185630f48a70304ea7b..978ce149be49617262ca6858ca95000899cc1db2 100644 (file)
@@ -28,7 +28,8 @@ uniform int hairThicknessRes = 1;
 
 #endif /* LIT_SURFACE_UNIFORM */
 
-/** AUTO CONFIG
+/**
+ * AUTO CONFIG
  * We include the file multiple times each time with a different configuration.
  * This leads to a lot of deadcode. Better idea would be to only generate the one needed.
  */
index 1073034383d00b865c80a433097ca7d0809e7b24..8a53883492e3092f976d8d94b09fadd6aec1b0fa 100644 (file)
@@ -116,7 +116,8 @@ EditBone *ED_armature_ebone_add_primitive(Object *obedit_arm, float length, bool
 /* previously addvert_armature */
 /* the ctrl-click method */
 
-/** Note this is already ported to multi-objects as it is.
+/**
+ * Note this is already ported to multi-objects as it is.
  * Since only the active bone is extruded even for single objects,
  * it makes sense to stick to the active object here.
  *
index 994d844287c11efeefa688c4cd3178b2ef4ba161..af2d92533c3d814dcd4c6c22ecadc20b3dd94703 100644 (file)
@@ -3341,7 +3341,8 @@ void CURVE_OT_reveal(wmOperatorType *ot)
 
 /********************** subdivide operator *********************/
 
-/** Divide the line segments associated with the currently selected
+/**
+ * Divide the line segments associated with the currently selected
  * curve nodes (Bezier or NURB). If there are no valid segment
  * selections within the current selection, nothing happens.
  */
index 4a354dabd303a43dd43acb4cc19a9aaaefebb6ff..11106dd403f8d77c34ad767b43acd1697b78e894 100644 (file)
@@ -2695,7 +2695,7 @@ void ui_but_clipboard_free(void)
  * It converts every UTF-8 character to an asterisk, and also remaps
  * the cursor position and selection start/end.
  *
- * \note: remapping is used, because password could contain UTF-8 characters.
+ * \note remapping is used, because password could contain UTF-8 characters.
  *
  * \{ */
 
@@ -6976,8 +6976,10 @@ static bool ui_numedit_but_CURVEPROFILE(uiBlock *block,
   return changed;
 }
 
-/** Interaction for curve profile widget.
- * \note Uses hardcoded keys rather than the keymap. */
+/**
+ * Interaction for curve profile widget.
+ * \note Uses hardcoded keys rather than the keymap.
+ */
 static int ui_do_but_CURVEPROFILE(
     bContext *C, uiBlock *block, uiBut *but, uiHandleButtonData *data, const wmEvent *event)
 {
index 7ce4242c697f0e4b5039edadb1a6f9e3a86efc08..8af82864b037ff9685f027ad17a7e4e838260c0a 100644 (file)
@@ -852,10 +852,10 @@ bool UI_context_copy_to_selected_list(bContext *C,
 }
 
 /**
- * called from both exec & poll
+ * Called from both exec & poll.
  *
- * \note: normally we wouldn't call a loop from within a poll function,
- * However this is a special case, and for regular poll calls, getting
+ * \note Normally we wouldn't call a loop from within a poll function,
+ * however this is a special case, and for regular poll calls, getting
  * the context from the button will fail early.
  */
 static bool copy_to_selected_button(bContext *C, bool all, bool poll)
@@ -1323,8 +1323,9 @@ static void UI_OT_editsource(wmOperatorType *ot)
 
 /**
  * EditTranslation utility funcs and operator,
- * \note: this includes utility functions and button matching checks.
- * this only works in conjunction with a py operator!
+ *
+ * \note this includes utility functions and button matching checks.
+ * this only works in conjunction with a Python operator!
  */
 static void edittranslation_find_po_file(const char *root,
                                          const char *uilng,
index b205572ba06d5485f2df488583b619e78e4dba35..f5c5ef5f5e2d8b0a318755e92fe04ac159957fac 100644 (file)
@@ -5068,8 +5068,10 @@ static void CurveProfile_buttons_layout(uiLayout *layout, PointerRNA *ptr, RNAUp
   UI_block_funcN_set(block, NULL, NULL, NULL);
 }
 
-/** Template for a path creation widget intended for custom bevel profiles.
- * This section is quite similar to uiTemplateCurveMapping, but with reduced complexity */
+/**
+ * Template for a path creation widget intended for custom bevel profiles.
+ * This section is quite similar to #uiTemplateCurveMapping, but with reduced complexity.
+ */
 void uiTemplateCurveProfile(uiLayout *layout, PointerRNA *ptr, const char *propname)
 {
   RNAUpdateCb *cb;
index 7f7352517c880cd828676ce2fd243b9de47734b2..f9e4248fde3c9cbc1d5790423ef7f153a5983561 100644 (file)
@@ -249,8 +249,9 @@ typedef struct uiWidgetBase {
   uiWidgetBaseParameters uniform_params;
 } uiWidgetBase;
 
-/** uiWidgetType: for time being only for visual appearance,
- * later, a handling callback can be added too
+/**
+ * For time being only for visual appearance,
+ * later, a handling callback can be added too.
  */
 typedef struct uiWidgetType {
 
index a405069efd852d5c242e0d70672672de4503d288..a4dd0cb5c9f36141e881116601252063d029007f 100644 (file)
@@ -971,9 +971,10 @@ const uchar *UI_ThemeGetColorPtr(bTheme *btheme, int spacetype, int colorid)
 }
 
 /**
- * initialize default theme
- * \note: when you add new colors, created & saved themes need initialized
- * use function below, init_userdef_do_versions()
+ * Initialize default theme.
+ *
+ * \note When you add new colors, created & saved themes need initialized
+ * use function below, #init_userdef_do_versions.
  */
 void UI_theme_init_default(void)
 {
index a918996563f689913e863f5e4a37643052647599..772e7446430d8e360f7e2f45475b4d54f366a195 100644 (file)
@@ -793,10 +793,12 @@ int join_mesh_shapes_exec(bContext *C, wmOperator *op)
 
 static MirrTopoStore_t mesh_topo_store = {NULL, -1. - 1, -1};
 
-/** mode is 's' start, or 'e' end, or 'u' use
+/**
+ * Mode is 's' start, or 'e' end, or 'u' use
  * if end, ob can be NULL.
- * \note, is supposed return -1 on error,
- * which callers are currently checking for, but is not used so far. */
+ * \note This is supposed return -1 on error,
+ * which callers are currently checking for, but is not used so far.
+ */
 int ED_mesh_mirror_topo_table(Object *ob, Mesh *me_eval, char mode)
 {
   if (mode == 'u') { /* use table */
index b534e1b9683ba7113656e7cb06732725f40d2727..826d1db253821e3dd55c6419f5ec62fecbaf42e2 100644 (file)
@@ -1550,8 +1550,10 @@ void OBJECT_OT_origin_set(wmOperatorType *ot)
 #define USE_RELATIVE_ROTATION
 /** Disable overlays, ignoring user setting (light wire gets in the way). */
 #define USE_RENDER_OVERRIDE
-/** Calculate a depth if the cursor isn't already over a depth
- * (not essential but feels buggy without). */
+/**
+ * Calculate a depth if the cursor isn't already over a depth
+ * (not essential but feels buggy without).
+ */
 #define USE_FAKE_DEPTH_INIT
 
 struct XFormAxisItem {
index 4c7e5e182571dc37187c571977ecfb780b0ff37e..fa4e250871e83dc458862d8576940178b62a55be 100644 (file)
@@ -190,9 +190,11 @@ BLI_INLINE unsigned char f_to_char(const float val)
 /* to avoid locking in tile initialization */
 #define TILE_PENDING POINTER_FROM_INT(-1)
 
-/** This is mainly a convenience struct used so we can keep an array of images we use -
+/**
+ * This is mainly a convenience struct used so we can keep an array of images we use -
  * their imbufs, etc, in 1 array, When using threads this array is copied for each thread
- * because 'partRedrawRect' and 'touch' values would not be thread safe */
+ * because 'partRedrawRect' and 'touch' values would not be thread safe.
+ */
 typedef struct ProjPaintImage {
   Image *ima;
   ImBuf *ibuf;
index d9850cb855ddff1fb317b649f19948f2c68b5484..a86a552f9f915c52817315aaaa7dfaa89ebc53ea 100644 (file)
@@ -33,7 +33,8 @@ enum FSMenuInsert;
 struct FSMenu;
 struct FSMenuEntry;
 
-/** Inserts a new fsmenu entry with the given \a path.
+/**
+ * Inserts a new fsmenu entry with the given \a path.
  * Duplicate entries are not added.
  * \param flag: Options for inserting the entry.
  */
index d7a7d57b1006082f7f331788a1e376baf98709c3..11f18357f7b77b5ce9f737393e9f366561b544a5 100644 (file)
@@ -415,7 +415,8 @@ static void outliner_collection_set_flag_recursive(Scene *scene,
   }
 }
 
-/** Check if collection is already isolated.
+/**
+ * Check if collection is already isolated.
  *
  * A collection is isolated if all its parents and children are "visible".
  * All the other collections must be "invisible".
index 4664d3c08ffc8574ee27f8d208c0f91ce138a806..476010a693dd25a03d37b2be5b784163661c637a 100644 (file)
@@ -546,7 +546,8 @@ static void merged_element_search_call_cb(struct bContext *C, void *UNUSED(arg1)
   }
 }
 
-/** Merged element search menu
+/**
+ * Merged element search menu
  * Created on activation of a merged or aggregated icon-row icon.
  */
 static uiBlock *merged_element_search_menu(bContext *C, ARegion *ar, void *data)
index 3eee76277e8f6edf6b9699e562b3a366dc703f40..092142a83cd9bc78e8b750f05c6bba13295f6e7c 100644 (file)
@@ -3925,8 +3925,9 @@ static bool mball_circle_select(ViewContext *vc,
   return data.is_changed;
 }
 
-/** Callbacks for circle selection in Editmode */
-
+/**
+ * Callbacks for circle selection in Editmode
+ */
 static bool obedit_circle_select(bContext *C,
                                  ViewContext *vc,
                                  wmGenericUserData *wm_userdata,
index 9a2f4062631fe964c698cbffa621665032aa56f0..35a116dc4b3e3af1b0e2d263b4040b768f10412d 100644 (file)
@@ -231,7 +231,8 @@ void VIEW3D_OT_snap_selected_to_grid(wmOperatorType *ot)
 
 /* *************************************************** */
 
-/** Snaps the selection as a whole (use_offset=true) or each selected object to the given location.
+/**
+ * Snaps the selection as a whole (use_offset=true) or each selected object to the given location.
  *
  * \param snap_target_global: a location in global space to snap to
  * (eg. 3D cursor or active object).
@@ -762,10 +763,11 @@ void VIEW3D_OT_snap_cursor_to_selected(wmOperatorType *ot)
 
 /* ********************************************** */
 
-/** Calculates the center position of the active object in global space.
+/**
+ * Calculates the center position of the active object in global space.
  *
  * Note: this could be exported to be a generic function.
- * see: calculateCenterActive
+ * see: #calculateCenterActive
  */
 static bool snap_calc_active_center(bContext *C, const bool select_only, float r_center[3])
 {
index c64ace77a794ebc5efcf9d6420b4b95537294512..d7f7e96ba08be3a5b7db475fe6f1e7e311299045 100644 (file)
@@ -963,8 +963,10 @@ static bool drw_select_filter_object_mode_lock(Object *ob, void *user_data)
   return BKE_object_is_mode_compat(ob, obact->mode);
 }
 
-/** Implement #VIEW3D_SELECT_FILTER_WPAINT_POSE_MODE_LOCK for special case when
- * we want to select pose bones (this doesn't switch modes). */
+/**
+ * Implement #VIEW3D_SELECT_FILTER_WPAINT_POSE_MODE_LOCK for special case when
+ * we want to select pose bones (this doesn't switch modes).
+ */
 static bool drw_select_filter_object_mode_lock_for_weight_paint(Object *ob, void *user_data)
 {
   LinkNode *ob_pose_list = user_data;
index e5e7be025e41f18dea3e5d59af3d47585bc467da..4b529765ab0bc3991bdf73e5ff0e1294c9bb9b4a 100644 (file)
@@ -213,8 +213,10 @@ typedef struct TransData2D {
   float ih1[2], ih2[2];
 } TransData2D;
 
-/** Used to store 2 handles for each #TransData in case the other handle wasn't selected. Also to
- * unset temporary flags. */
+/**
+ * Used to store 2 handles for each #TransData in case the other handle wasn't selected.
+ * Also to unset temporary flags.
+ */
 typedef struct TransDataCurveHandleFlags {
   char ih1, ih2;
   char *h1, *h2;
index b9d69cafd0c508852b8c9a9b822175a7bec35dac..8b7dcecf9e80baa04f68f58c8bfc9de690d6f2f7 100644 (file)
@@ -192,8 +192,8 @@ static void editmesh_set_connectivity_distance(BMesh *bm,
             if (e_iter->l) {
               BMLoop *l_iter_radial, *l_first_radial;
               /**
-               * imaginary edge diagonally across quad,
-               * \note, this takes advantage of the rules of winding that we
+               * imaginary edge diagonally across quad.
+               * \note This takes advantage of the rules of winding that we
                * know 2 or more of a verts edges wont reference the same face twice.
                * Also, if the edge is hidden, the face will be hidden too.
                */
index 14e8b8f97e02cd26cc0f6431f07a50c67653754b..41486a2f767f46ac1d45416e53f7ff147305fcdb 100644 (file)
@@ -65,7 +65,7 @@
 #include "transform.h"
 
 /* -------------------------------------------------------------------- */
-/** Internal Data Types
+/** \name Internal Data Types
  * \{ */
 
 #define MAX_CLIPPLANE_LEN 3
@@ -147,7 +147,7 @@ struct SnapObjectContext {
 /** \} */
 
 /* -------------------------------------------------------------------- */
-/** Common Utilities
+/** \name Common Utilities
  * \{ */
 
 /**
@@ -1003,7 +1003,7 @@ static bool raycastObjects(SnapObjectContext *sctx,
 /** \} */
 
 /* -------------------------------------------------------------------- */
-/** Snap Nearest utilities
+/** \name Snap Nearest utilities
  * \{ */
 
 /* Test BoundBox */
@@ -1161,7 +1161,7 @@ static bool test_projected_edge_dist(const struct DistProjectedAABBPrecalc *prec
 /** \} */
 
 /* -------------------------------------------------------------------- */
-/** Walk DFS
+/** \name Walk DFS
  * \{ */
 
 typedef void (*Nearest2DGetVertCoCallback)(const int index, const float **co, void *data);
index 8abd8db53c196cff9983369141a38c63016f0b5d..aca695be2452c87c3fc253e804a1ecc56e2ab7b5 100644 (file)
@@ -45,7 +45,8 @@
 /* Numeric input which isn't allowing full numeric editing. */
 #define USE_FAKE_EDIT
 
-/** #NumInput.flag
+/**
+ * #NumInput.flag
  * (1 << 8) and below are reserved for public flags!
  */
 enum {
index f4a94c7759a63bdd491527356eb8dded7e337d4b..b169b84c5b850e8a2f458a678d6bf4d5ffc7072a 100644 (file)
@@ -372,7 +372,8 @@ typedef struct GPUShaderConfigData {
 /* gpu_shader.c */
 extern const GPUShaderConfigData GPU_shader_cfg_data[GPU_SHADER_CFG_LEN];
 
-/** Keep these in sync with:
+/**
+ * Keep these in sync with:
  * - `gpu_shader_image_interlace_frag.glsl`
  * - `gpu_shader_image_rect_interlace_frag.glsl`
  */
index c234e064d369b46cc9bd56dc04e1c0c236baf2d2..bc2bf998145320d36c977f0303150f24839159e3 100644 (file)
@@ -67,7 +67,7 @@ void node_tex_image_nearest(vec3 co, sampler2D ima, out vec4 color, out float al
   alpha = color.a;
 }
 
-/* @arg f: signed distance to texel center. */
+/** \param f: Signed distance to texel center. */
 void cubic_bspline_coefs(vec2 f, out vec2 w0, out vec2 w1, out vec2 w2, out vec2 w3)
 {
   vec2 f2 = f * f;
index 64a8db6c526fe10e6eeafb9316cabd22ba5d4f9c..fc08e17dd967211d4da87db29ad759ca71d3310f 100644 (file)
@@ -28,7 +28,8 @@ struct IDProperty;
 struct ImBuf;
 struct anim;
 
-/** The metadata is a list of key/value pairs (both char *) that can me
+/**
+ * The metadata is a list of key/value pairs (both char *) that can me
  * saved in the header of several image formats.
  * Apart from some common keys like
  * 'Software' and 'Description' (png standard) we'll use keys within the
@@ -38,29 +39,32 @@ struct anim;
  * The keys & values are stored in ID properties, in the group "metadata".
  */
 
-/** Ensure that the metadata property is a valid IDProperty object.
+/**
+ * Ensure that the metadata property is a valid #IDProperty object.
  * This is a no-op when *metadata != NULL.
  */
 void IMB_metadata_ensure(struct IDProperty **metadata);
 void IMB_metadata_free(struct IDProperty *metadata);
 
-/** Read the field from the image info into the field.
- * \param metadata: the IDProperty that contains the metadata
+/**
+ * Read the field from the image info into the field.
+ * \param metadata: the #IDProperty that contains the metadata
  * \param key: the key of the field
  * \param value: the data in the field, first one found with key is returned,
  *                 memory has to be allocated by user.
  * \param len: length of value buffer allocated by user.
- * \return    - 1 (true) if metadata is present and value for the key found, 0 (false) otherwise
+ * \return 1 (true) if metadata is present and value for the key found, 0 (false) otherwise.
  */
 bool IMB_metadata_get_field(struct IDProperty *metadata,
                             const char *key,
                             char *value,
                             const size_t len);
 
-/** Set user data in the metadata.
+/**
+ * Set user data in the metadata.
  * If the field already exists its value is overwritten, otherwise the field
  * will be added with the given value.
- * \param metadata: the IDProperty that contains the metadata
+ * \param metadata: the #IDProperty that contains the metadata
  * \param key: the key of the field
  * \param value: the data to be written to the field. zero terminated string
  */
index 5c7a60bbdcf05cbf59de6fbea323bbeb03c3845a..00e9a810ef301314ed5665217539e22b1c8af6f1 100644 (file)
@@ -30,7 +30,8 @@ extern "C" {
 
 struct ImBuf;
 
-/** Thumbnail creation and retrieval according to the 'Thumbnail Management Standard'
+/**
+ * Thumbnail creation and retrieval according to the 'Thumbnail Management Standard'
  * supported by Gimp, Gnome (Nautilus), KDE etc.
  * Reference: http://jens.triq.net/thumbnail-spec/index.html
  */
index 7150e41841bdd07cc190215b070ae3741f1526aa..7915f04b74ece01b129b9fc5d015fe5acd3f4052 100644 (file)
@@ -213,7 +213,9 @@ void IMB_blend_color_float(float dst[4],
   }
 }
 
-/** Crop */
+/* -------------------------------------------------------------------- */
+/** \name Crop
+ * \{ */
 
 static void rect_crop_4bytes(void **buf_p, const int size_src[2], const rcti *crop)
 {
@@ -279,8 +281,9 @@ void IMB_rect_crop(ImBuf *ibuf, const rcti *crop)
   ibuf->y = size_dst[1];
 }
 
-/** Re-alloc buffers at a new size */
-
+/**
+ * Re-alloc buffers at a new size.
+ */
 static void rect_realloc_4bytes(void **buf_p, const uint size[2])
 {
   if (*buf_p == NULL) {
@@ -318,6 +321,8 @@ void IMB_rect_size_set(ImBuf *ibuf, const uint size[2])
   ibuf->y = size[1];
 }
 
+/** \} */
+
 /* clipping */
 
 void IMB_rectclip(ImBuf *dbuf,
index 06b8019a24decd6b9f30ec248654ae71108f9d73..eb4b29e81c1251df6efe7742f4aa7f9a56fb3793 100644 (file)
@@ -132,11 +132,17 @@ static bool get_thumb_dir(char *dir, ThumbSize size)
 
 #undef THUMBNAILS
 
-/** ----- begin of adapted code from glib ---
+/* --- Begin of adapted code from glib. --- */
+
+/* -------------------------------------------------------------------- */
+/** \name Escape URI String
+ *
  * The following code is adapted from function g_escape_uri_string from the gnome glib
  * Source: http://svn.gnome.org/viewcvs/glib/trunk/glib/gconvert.c?view=markup
  * released under the Gnu General Public License.
- */
+ *
+ * \{ */
+
 typedef enum {
   UNSAFE_ALL = 0x1,        /* Escape all unsafe characters   */
   UNSAFE_ALLOW_PLUS = 0x2, /* Allows '+'  */
@@ -295,7 +301,9 @@ static void escape_uri_string(const char *string,
   *q = '\0';
 }
 
-/** ----- end of adapted code from glib --- */
+/** \} */
+
+/* --- End of adapted code from glib. --- */
 
 static bool thumbhash_from_path(const char *UNUSED(path), ThumbSource source, char *r_hash)
 {
index dba05da910e75f7a050536e3f06170ba227cba5a..13e638437c47f8d4a6e5cb10c6311fcbbcbc6858 100644 (file)
@@ -33,7 +33,8 @@
 /** Dynamic size of widget's high resolution table. Input should be profile->totpoint. */
 #define PROF_N_TABLE(n_pts) min_ii(PROF_TABLE_MAX, (((n_pts - 1)) * PROF_RESOL) + 1)
 
-/** Each control point that makes up the profile.
+/**
+ * Each control point that makes up the profile.
  * \note The flags use the same enum as Bezier curves, but they aren't guaranteed
  * to have identical functionality, and all types aren't implemented.
  */
index 9799489982dd85fbdba41fd910ea0cdb22ee3229..0a6423d569f1845f2d8b908fe93be3ab60f6f894 100644 (file)
@@ -32,7 +32,7 @@ extern "C" {
 
 #include "DNA_defs.h"
 
-/** descriptor and storage for a custom data layer */
+/** Descriptor and storage for a custom data layer. */
 typedef struct CustomDataLayer {
   /** Type of data in layer. */
   int type;
@@ -63,9 +63,11 @@ typedef struct CustomDataExternal {
   char filename[1024];
 } CustomDataExternal;
 
-/** structure which stores custom element data associated with mesh elements
+/**
+ * Structure which stores custom element data associated with mesh elements
  * (vertices, edges or faces). The custom data is organized into a series of
- * layers, each with a data type (e.g. MTFace, MDeformVert, etc.). */
+ * layers, each with a data type (e.g. MTFace, MDeformVert, etc.).
+ */
 typedef struct CustomData {
   /** CustomDataLayers, ordered by type. */
   CustomDataLayer *layers;
index f6a7a8a5f5b6217d2b415c2ef6b41b38e5c58ab9..ebaaf72b3aebe16f682868715ba1c2287b20e6b3 100644 (file)
@@ -59,9 +59,10 @@ typedef struct MVert {
   char flag, bweight;
 } MVert;
 
-/** Tessellation vertex color data.
+/**
+ * Tessellation vertex color data.
  * at the moment alpha is abused for vertex painting and not used for transparency,
- * note that red and blue are swapped
+ * note that red and blue are swapped.
  */
 typedef struct MCol {
   unsigned char a, r, g, b;
index 75fca117b06baccbc46f077d0dffcbbd7b125866..3214de5b3c6e556e6ec1ff4076c4a0bb130b03b9 100644 (file)
@@ -49,8 +49,10 @@ typedef enum eObjectMode {
 /** Any mode that uses Object.sculpt. */
 #define OB_MODE_ALL_SCULPT (OB_MODE_SCULPT | OB_MODE_VERTEX_PAINT | OB_MODE_WEIGHT_PAINT)
 
-/** Any mode that has data or for Grease Pencil modes, we need to free when switching modes,
- * see: #ED_object_mode_generic_exit */
+/**
+ * Any mode that has data or for Grease Pencil modes, we need to free when switching modes,
+ * see: #ED_object_mode_generic_exit
+ */
 #define OB_MODE_ALL_MODE_DATA \
   (OB_MODE_EDIT | OB_MODE_VERTEX_PAINT | OB_MODE_WEIGHT_PAINT | OB_MODE_SCULPT | OB_MODE_POSE | \
    OB_MODE_PAINT_GPENCIL | OB_MODE_EDIT_GPENCIL | OB_MODE_SCULPT_GPENCIL | \
index 34a1b6d3e0bc67baf8e6291bf5a5cef3c0472b78..8afb74e0786e366033d7a68ed0610e7de6c905ff 100644 (file)
@@ -492,8 +492,10 @@ typedef struct SoftBody {
 #define PTCACHE_READ_INFO (1 << 10)
 /** don't use the filename of the blendfile the data is linked from (write a local cache) */
 #define PTCACHE_IGNORE_LIBPATH (1 << 11)
-/** high resolution cache is saved for smoke for backwards compatibility,
- * so set this flag to know it's a "fake" cache */
+/**
+ * High resolution cache is saved for smoke for backwards compatibility,
+ * so set this flag to know it's a "fake" cache.
+ */
 #define PTCACHE_FAKE_SMOKE (1 << 12)
 #define PTCACHE_IGNORE_CLEAR (1 << 13)
 
index e60b16453b20b455e730d730ece21121da02323d..0de43c1632f4f91df9ae3dddcdcf38031bf2d6d7 100644 (file)
@@ -400,7 +400,7 @@ typedef enum eStereo3dInterlaceType {
 typedef struct ImageFormatData {
   /**
    * R_IMF_IMTYPE_PNG, R_...
-   * \note, video types should only ever be set from this structure when used from RenderData.
+   * \note Video types should only ever be set from this structure when used from #RenderData.
    */
   char imtype;
   /**
index 8e4c4cc6ed4bbd02f011f195771ea208c4c33caa..9e8bda2d12f32e562a6d1702b128f372058d5458 100644 (file)
@@ -973,7 +973,8 @@ typedef struct FileDirEntry {
   int act_variant;
 } FileDirEntry;
 
-/** Array of direntries.
+/**
+ * Array of direntries.
  *
  * This struct is used in various, different contexts.
  *
index 2332fe39de33b89b2a051fdf2c7801fa8f0ebf3d..3e10e817946ca50e48953a23aff2b49b19addc7a 100644 (file)
@@ -38,8 +38,10 @@ struct ColorBand;
 
 #define MAX_STYLE_NAME 64
 
-/** default offered by Blender.
- * #uiFont.uifont_id */
+/**
+ * Default offered by Blender.
+ * #uiFont.uifont_id
+ */
 typedef enum eUIFont_ID {
   UIFONT_DEFAULT = 0,
   /*  UIFONT_BITMAP   = 1 */ /* UNUSED */
@@ -1024,9 +1026,11 @@ typedef enum eUserpref_UI_Flag {
   USER_HIDE_SYSTEM_BOOKMARKS = (1u << 31),
 } eUserpref_UI_Flag;
 
-/** #UserDef.uiflag2
+/**
+ * #UserDef.uiflag2
  *
- * \note don't add new flags here, use 'uiflag' which has flags free. */
+ * \note don't add new flags here, use 'uiflag' which has flags free.
+ */
 typedef enum eUserpref_UI_Flag2 {
   USER_UIFLAG2_UNUSED_0 = (1 << 0), /* cleared */
   USER_REGION_OVERLAP = (1 << 1),
@@ -1052,8 +1056,10 @@ typedef enum eUserpref_APP_Flag {
   USER_APP_LOCK_UI_LAYOUT = (1 << 0),
 } eUserpref_APP_Flag;
 
-/** Auto-Keying mode.
- * #UserDef.autokey_mode */
+/**
+ * Auto-Keying mode.
+ * #UserDef.autokey_mode
+ */
 typedef enum eAutokey_Mode {
   /* AUTOKEY_ON is a bitflag */
   AUTOKEY_ON = 1,
@@ -1064,15 +1070,18 @@ typedef enum eAutokey_Mode {
   AUTOKEY_MODE_EDITKEYS = 5,
 } eAutokey_Mode;
 
-/** Zoom to frame mode.
- * #UserDef.view_frame_type */
+/**
+ * Zoom to frame mode.
+ * #UserDef.view_frame_type
+ */
 typedef enum eZoomFrame_Mode {
   ZOOM_FRAME_MODE_KEEP_RANGE = 0,
   ZOOM_FRAME_MODE_SECONDS = 1,
   ZOOM_FRAME_MODE_KEYFRAMES = 2,
 } eZoomFrame_Mode;
 
-/** Auto-Keying flag
+/**
+ * Auto-Keying flag
  * #UserDef.autokey_flag (not strictly used when autokeying only -
  * is also used when keyframing these days).
  * \note #eAutokey_Flag is used with a macro, search for lines like IS_AUTOKEY_FLAG(INSERTAVAIL).
@@ -1121,16 +1130,20 @@ typedef enum eDupli_ID_Flags {
   USER_DUP_GPENCIL = (1 << 13),
 } eDupli_ID_Flags;
 
-/** Max anti alias draw method
- * #UserDef.gpu_viewport_antialias */
+/**
+ * Max anti alias draw method
+ * #UserDef.gpu_viewport_antialias
+ */
 typedef enum eOpenGL_AntiAliasMethod {
   USER_AA_NONE = 0,
   USER_AA_FXAA = 1,
   USER_AA_TAA8 = 2,
 } eOpenGL_AntiAliasMethod;
 
-/** Text draw options
- * #UserDef.text_render */
+/**
+ * Text draw options
+ * #UserDef.text_render
+ */
 typedef enum eText_Draw_Options {
   USER_TEXT_DISABLE_AA = (1 << 0),
 
@@ -1139,8 +1152,10 @@ typedef enum eText_Draw_Options {
   USER_TEXT_HINTING_FULL = (1 << 3),
 } eText_Draw_Options;
 
-/** Grease Pencil Settings.
- * #UserDef.gp_settings */
+/**
+ * Grease Pencil Settings.
+ * #UserDef.gp_settings
+ */
 typedef enum eGP_UserdefSettings {
   GP_PAINT_UNUSED_0 = (1 << 0),
 } eGP_UserdefSettings;
@@ -1149,8 +1164,10 @@ enum {
   USER_GIZMO_DRAW = (1 << 0),
 };
 
-/** Color Picker Types.
- * #UserDef.color_picker_type */
+/**
+ * Color Picker Types.
+ * #UserDef.color_picker_type
+ */
 typedef enum eColorPicker_Types {
   USER_CP_CIRCLE_HSV = 0,
   USER_CP_SQUARE_SV = 1,
@@ -1159,8 +1176,10 @@ typedef enum eColorPicker_Types {
   USER_CP_CIRCLE_HSL = 4,
 } eColorPicker_Types;
 
-/** Timecode display styles
- * #UserDef.timecode_style */
+/**
+ * Timecode display styles
+ * #UserDef.timecode_style
+ */
 typedef enum eTimecodeStyles {
   /**
    * As little info as is necessary to show relevant info with '+' to denote the frames
index d6f52e48ebea73d3a15f760f29013e6434b532ae..f4bc79b786af6bb4c0b74c16c3b15803dda131b1 100644 (file)
@@ -159,7 +159,8 @@ static short *types_size_native;
 static short *types_size_32;
 /** Contains sizes as they are calculated on 64 bit systems. */
 static short *types_size_64;
-/** At `sp = structs[a]` is the first address of a struct definition:
+/**
+ * At `sp = structs[a]` is the first address of a struct definition:
  * - `sp[0]` is type number.
  * - `sp[1]` is the length of the element array (next).
  * - `sp[2]` sp[3] is [(type_index, name_index), ..] (number of pairs is defined by `sp[1]`),
index 2a3412492475dab6f2c55e97c26a94818a838faf..6a60f09919bfa2aeb668ffdd140fdcb827b4f543 100644 (file)
@@ -37,7 +37,8 @@ struct ReportList;
 struct StructRNA;
 struct bContext;
 
-/** Pointer
+/**
+ * Pointer
  *
  * RNA pointers are not a single C pointer but include the type,
  * and a pointer to the ID struct that owns the struct, since
index c3a81f0c6e125297cc1fb630ed05a24fa4ada7f8..a22b261368ccde439327f25e482f891ea2ad0842 100644 (file)
@@ -227,7 +227,8 @@ bool RNA_struct_equals(Main *bmain, PointerRNA *ptr_a, PointerRNA *ptr_b, eRNACo
 
 /* Low-level functions, also used by non-override RNA API like copy or equality check. */
 
-/** Generic RNA property diff function.
+/**
+ * Generic RNA property diff function.
  *
  * \note about \a prop and \a prop_a/prop_b parameters:
  * the former is expected to be an 'un-resolved' one,
@@ -816,8 +817,10 @@ bool RNA_struct_override_matches(Main *bmain,
   return matching;
 }
 
-/** Store needed second operands into \a storage data-block
- * for differential override operations. */
+/**
+ * Store needed second operands into \a storage data-block
+ * for differential override operations.
+ */
 bool RNA_struct_override_store(Main *bmain,
                                PointerRNA *ptr_local,
                                PointerRNA *ptr_reference,
@@ -977,8 +980,10 @@ static void rna_property_override_apply_ex(Main *bmain,
   }
 }
 
-/** Apply given \a override operations on \a ptr_dst, using \a ptr_src
- * (and \a ptr_storage for differential ops) as source. */
+/**
+ * Apply given \a override operations on \a ptr_dst, using \a ptr_src
+ * (and \a ptr_storage for differential ops) as source.
+ */
 void RNA_struct_override_apply(Main *bmain,
                                PointerRNA *ptr_dst,
                                PointerRNA *ptr_src,
index 7e23289433fc93c0be5bfe36c7f6defa4fca5e97..553743272a261fe74e19c3098785628812d33351 100644 (file)
@@ -79,8 +79,10 @@ typedef struct Vert2GeomData {
   float *dist[3];
 } Vert2GeomData;
 
-/** Data which is localized to each computed chunk
- * (i.e. thread-safe, and with continuous subset of index range). */
+/**
+ * Data which is localized to each computed chunk
+ * (i.e. thread-safe, and with continuous subset of index range).
+ */
 typedef struct Vert2GeomDataChunk {
   /* Read-only data */
   float last_hit_co[3][3];
index 2e15c1d9ce0339158a7fe469af48550234c5270e..0fd6d74c324e5f20ea9be6370a3d411ff39d9f64 100644 (file)
@@ -384,19 +384,21 @@ PyObject *BPy_BMLoopColor_CreatePyObject(struct MLoopCol *data)
  * This is python type wraps a deform vert as a python dictionary,
  * hiding the #MDeformWeight on access, since the mapping is very close, eg:
  *
- * C:
- *     weight = defvert_find_weight(dv, group_nr);
- *     defvert_remove_group(dv, dw)
+ * \code{.c}
+ * weight = defvert_find_weight(dv, group_nr);
+ * defvert_remove_group(dv, dw)
+ * \endcode
  *
- * Py:
- *     weight = dv[group_nr]
- *     del dv[group_nr]
+ * \code{.py}
+ * weight = dv[group_nr]
+ * del dv[group_nr]
+ * \endcode
  *
- * \note: there is nothing BMesh specific here,
+ * \note There is nothing BMesh specific here,
  * its only that BMesh is the only part of blender that uses a hand written api like this.
  * This type could eventually be used to access lattice weights.
  *
- * \note: Many of blender-api's dict-like-wrappers act like ordered dicts,
+ * \note Many of blender-api's dict-like-wrappers act like ordered dicts,
  * This is intentionally _not_ ordered, the weights can be in any order and it won't matter,
  * the order should not be used in the api in any meaningful way (as with a python dict)
  * only expose as mapping, not a sequence.
index 4c14f8ca8d38e1ac6e029bc7d5386611e2893d2f..6fb2b2fd7eef2e002533a0624f3487ce5fcbbc07 100644 (file)
@@ -2596,7 +2596,8 @@ static PyObject *pyrna_prop_collection_subscript_slice(BPy_PropertyRNA *self,
   return list;
 }
 
-/** TODO - dimensions
+/**
+ * TODO - dimensions
  * \note Could also use pyrna_prop_array_to_py_index(self, count) in a loop, but it's much slower
  * since at the moment it reads (and even allocates) the entire array for each index.
  */
index c6ea5d6d167c67e5240dbba63c718cfe627863a8..f7537f5ea9cffdd3cb7a70a0387769490db04279 100644 (file)
@@ -675,8 +675,10 @@ enum {
   WM_JOB_PROGRESS = (1 << 2),
 };
 
-/** Identifying jobs by owner alone is unreliable, this isnt saved,
- * order can change (keep 0 for 'any'). */
+/**
+ * Identifying jobs by owner alone is unreliable, this isnt saved,
+ * order can change (keep 0 for 'any').
+ */
 enum {
   WM_JOB_TYPE_ANY = 0,
   WM_JOB_TYPE_COMPOSITE,
index dd568d7baf1cfbffee88c1a3a21b3304082db0d1..a8ca65a8a8341da6ef9a2179afbd33ee5d9d82e4 100644 (file)
@@ -686,11 +686,13 @@ void WM_gizmo_properties_sanitize(PointerRNA *ptr, const bool no_context)
   RNA_STRUCT_END;
 }
 
-/** set all props to their default,
+/**
+ * Set all props to their default.
+ *
  * \param do_update: Only update un-initialized props.
  *
- * \note, there's nothing specific to gizmos here.
- * this could be made a general function.
+ * \note There's nothing specific to gizmos here.
+ * This could be made a general function.
  */
 bool WM_gizmo_properties_default(PointerRNA *ptr, const bool do_update)
 {
index 9c3c433d67551c9dfa048b0de1f5fe4371983516..61f51de41a5752427da7b4d1afedd6e6834ca990 100644 (file)
@@ -644,11 +644,13 @@ void WM_operator_properties_sanitize(PointerRNA *ptr, const bool no_context)
   RNA_STRUCT_END;
 }
 
-/** set all props to their default,
+/**
+ * Set all props to their default.
+ *
  * \param do_update: Only update un-initialized props.
  *
- * \note, there's nothing specific to operators here.
- * this could be made a general function.
+ * \note There's nothing specific to operators here.
+ * This could be made a general function.
  */
 bool WM_operator_properties_default(PointerRNA *ptr, const bool do_update)
 {