diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-07-14 08:19:52 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-07-14 08:19:52 +0300 |
commit | 5338b36fccdafde6cf5cdc35df16770055ad8fef (patch) | |
tree | 39dbf1b8206367e7f40ac6126b4aebcdb90d80b7 /source | |
parent | b818f6b55ff0cd13445917715591d8eb38130c82 (diff) |
Cleanup: spelling
Diffstat (limited to 'source')
-rw-r--r-- | source/blender/blenkernel/intern/appdir.c | 22 | ||||
-rw-r--r-- | source/blender/bmesh/tools/bmesh_bevel.c | 5 | ||||
-rw-r--r-- | source/blender/editors/gizmo_library/gizmo_types/cage2d_gizmo.c | 6 | ||||
-rw-r--r-- | source/blender/imbuf/intern/tiff.c | 6 |
4 files changed, 20 insertions, 19 deletions
diff --git a/source/blender/blenkernel/intern/appdir.c b/source/blender/blenkernel/intern/appdir.c index 0d01176ec2a..2cc715464ad 100644 --- a/source/blender/blenkernel/intern/appdir.c +++ b/source/blender/blenkernel/intern/appdir.c @@ -56,7 +56,7 @@ # ifdef WITH_BINRELOC # include "binreloc.h" # endif -/* mkdtemp on OSX (and probably all *BSD?), not worth making specific check for this OS. */ +/* #mkdtemp on OSX (and probably all *BSD?), not worth making specific check for this OS. */ # include <unistd.h> #endif /* WIN32 */ @@ -120,7 +120,7 @@ static char *blender_version_decimal(const int ver) } /** - * Concatenates path_base, (optional) path_sep and (optional) folder_name into targetpath, + * Concatenates path_base, (optional) path_sep and (optional) folder_name into \a targetpath, * returning true if result points to a directory. */ static bool test_path(char *targetpath, @@ -138,14 +138,14 @@ static bool test_path(char *targetpath, BLI_strncpy(tmppath, path_base, sizeof(tmppath)); } - /* rare cases folder_name is omitted (when looking for ~/.config/blender/2.xx dir only) */ + /* Rare cases folder_name is omitted (when looking for `~/.config/blender/2.xx` dir only). */ if (folder_name) { BLI_join_dirfile(targetpath, targetpath_len, tmppath, folder_name); } else { BLI_strncpy(targetpath, tmppath, targetpath_len); } - /* FIXME: why is "//" on front of tmppath expanded to "/" (by BLI_join_dirfile) + /* FIXME: why is "//" on front of \a tmppath expanded to "/" (by BLI_join_dirfile) * if folder_name is specified but not otherwise? */ if (BLI_is_dir(targetpath)) { @@ -190,7 +190,7 @@ static bool test_env_path(char *path, const char *envvar) /** * Constructs in \a targetpath the name of a directory relative to a version-specific - * subdirectory in the parent directory of the Blender executable. + * sub-directory in the parent directory of the Blender executable. * * \param targetpath: String to return path * \param folder_name: Optional folder name within version-specific directory @@ -307,7 +307,7 @@ static bool get_path_environment_notest(char *targetpath, * \param targetpath: String to return path * \param folder_name: default name of folder within user area * \param subfolder_name: optional name of subfolder within folder - * \param ver: Blender version, used to construct a subdirectory name + * \param ver: Blender version, used to construct a sub-directory name * \return true if it was able to construct such a path. */ static bool get_path_user(char *targetpath, @@ -350,8 +350,8 @@ static bool get_path_user(char *targetpath, * * \param targetpath: String to return path * \param folder_name: default name of folder within installation area - * \param subfolder_name: optional name of subfolder within folder - * \param ver: Blender version, used to construct a subdirectory name + * \param subfolder_name: optional name of sub-folder within folder + * \param ver: Blender version, used to construct a sub-directory name * \return true if it was able to construct such a path. */ static bool get_path_system(char *targetpath, @@ -635,7 +635,7 @@ const char *BKE_appdir_folder_id_version(const int folder_id, const int ver, con * adds the correct extension (.com .exe etc) from * $PATHEXT if necessary. Also on Windows it translates * the name to its 8.3 version to prevent problems with - * spaces and stuff. Final result is returned in fullname. + * spaces and stuff. Final result is returned in \a fullname. * * \param fullname: The full path and full name of the executable * (must be FILE_MAX minimum) @@ -975,7 +975,7 @@ static void where_is_temp(char *fullname, char *basename, const size_t maxlen, c /** * Sets btempdir_base to userdir if specified and is a valid directory, otherwise * chooses a suitable OS-specific temporary directory. - * Sets btempdir_session to a mkdtemp-generated sub-dir of btempdir_base. + * Sets btempdir_session to a #mkdtemp generated sub-dir of btempdir_base. * * \note On Window userdir will be set to the temporary directory! */ @@ -1021,7 +1021,7 @@ void BKE_tempdir_session_purge(void) /* Gets a good default directory for fonts */ bool BKE_appdir_font_folder_default( - /* This parameter can only be const on non-windows plaforms. + /* This parameter can only be `const` on non-windows platforms. * NOLINTNEXTLINE: readability-non-const-parameter. */ char *dir) { diff --git a/source/blender/bmesh/tools/bmesh_bevel.c b/source/blender/bmesh/tools/bmesh_bevel.c index b109dc3199a..626d58f75f8 100644 --- a/source/blender/bmesh/tools/bmesh_bevel.c +++ b/source/blender/bmesh/tools/bmesh_bevel.c @@ -1353,8 +1353,9 @@ static void offset_meet(EdgeHalf *e1, /** * Calculate the meeting point between e1 and e2 (one of which should have zero offsets), - * where e1 precedes e2 in CCW order around their common vertex v (viewed from normal side). - * If r_angle is provided, return the angle between e and emeet in *r_angle. + * where \a e1 precedes \a e2 in CCW order around their common vertex \a v + * (viewed from normal side). + * If \a r_angle is provided, return the angle between \a e and \a meetco in `*r_angle`. * If the angle is 0, or it is 180 degrees or larger, there will be no meeting point; * return false in that case, else true. */ diff --git a/source/blender/editors/gizmo_library/gizmo_types/cage2d_gizmo.c b/source/blender/editors/gizmo_library/gizmo_types/cage2d_gizmo.c index fd24149e9ea..85f84af5f14 100644 --- a/source/blender/editors/gizmo_library/gizmo_types/cage2d_gizmo.c +++ b/source/blender/editors/gizmo_library/gizmo_types/cage2d_gizmo.c @@ -637,7 +637,7 @@ static void gizmo_cage2d_draw_intern(wmGizmo *gz, } if (select) { - /* expand for hotspot */ + /* Expand for hot-spot. */ const float size[2] = {size_real[0] + margin[0] / 2, size_real[1] + margin[1] / 2}; if (transform_flag & ED_GIZMO_CAGE2D_XFORM_FLAG_SCALE) { @@ -694,7 +694,7 @@ static void gizmo_cage2d_draw_intern(wmGizmo *gz, bool show = false; if (gz->highlight_part == ED_GIZMO_CAGE2D_PART_TRANSLATE) { /* Only show if we're drawing the center handle - * otherwise the entire rectangle is the hotspot. */ + * otherwise the entire rectangle is the hot-spot. */ if (draw_options & ED_GIZMO_CAGE2D_DRAW_FLAG_XFORM_CENTER_HANDLE) { show = true; } @@ -805,7 +805,7 @@ static int gizmo_cage2d_test_select(bContext *C, wmGizmo *gz, const int mval[2]) return -1; } - /* expand for hotspot */ + /* Expand for hots-pot. */ const float size[2] = {size_real[0] + margin[0] / 2, size_real[1] + margin[1] / 2}; const int transform_flag = RNA_enum_get(gz->ptr, "transform"); diff --git a/source/blender/imbuf/intern/tiff.c b/source/blender/imbuf/intern/tiff.c index 20e894fa942..715f2aaf621 100644 --- a/source/blender/imbuf/intern/tiff.c +++ b/source/blender/imbuf/intern/tiff.c @@ -84,7 +84,7 @@ typedef struct ImbTIFFMemFile { static void imb_tiff_DummyUnmapProc( thandle_t fd, tdata_t base, - /* Cannot be const, because this function implemements TIFFUnmapFileProc. + /* Cannot be const, because this function implements #TIFFUnmapFileProc. * NOLINTNEXTLINE: readability-non-const-parameter. */ toff_t size) { @@ -96,7 +96,7 @@ static void imb_tiff_DummyUnmapProc( static int imb_tiff_DummyMapProc( thandle_t fd, tdata_t *pbase, - /* Cannot be const, because this function implemements TIFFMapFileProc. + /* Cannot be const, because this function implements #TIFFMapFileProc. * NOLINTNEXTLINE: readability-non-const-parameter. */ toff_t *psize) { @@ -110,7 +110,7 @@ static int imb_tiff_DummyMapProc( /** * Reads data from an in-memory TIFF file. * - * \param handle: Handle of the TIFF file (pointer to ImbTIFFMemFile). + * \param handle: Handle of the TIFF file (pointer to #ImbTIFFMemFile). * \param data: Buffer to contain data (treat as (void *)). * \param n: Number of bytes to read. * |