[Bf-blender-cvs] [a9dceed2a71] master: Cleanup: comments, spelling

[Campbell Barton]

Commit: a9dceed2a71c03303815b71a0b35724df4e632c5
Author: Campbell Barton
Date:   Tue Sep 22 15:16:36 2020 +1000
Branches: master
https://developer.blender.org/rBa9dceed2a71c03303815b71a0b35724df4e632c5

Cleanup: comments, spelling

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

M	source/blender/editors/gpencil/gpencil_trace_utils.c
M	source/blender/imbuf/intern/tiff.c

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

diff --git a/source/blender/editors/gpencil/gpencil_trace_utils.c b/source/blender/editors/gpencil/gpencil_trace_utils.c
index f7776da03b7..05973afe80c 100644
--- a/source/blender/editors/gpencil/gpencil_trace_utils.c
+++ b/source/blender/editors/gpencil/gpencil_trace_utils.c
@@ -47,8 +47,8 @@
 #include "gpencil_trace.h"
 
 /**
- * Print trace bitmap for debuging
- * \param f: Output handle. Use stderr for printing
+ * Print trace bitmap for debugging.
+ * \param f: Output handle. Use `stderr` for printing
  * \param bm: Trace bitmap
  */
 void ED_gpencil_trace_bitmap_print(FILE *f, const potrace_bitmap_t *bm)
@@ -81,7 +81,7 @@ void ED_gpencil_trace_bitmap_print(FILE *f, const potrace_bitmap_t *bm)
  * Return new un-initialized trace bitmap
  * \param w: Width in pixels
  * \param h: Height in pixels
- * \return: Trace bitmap
+ * \return Trace bitmap
  */
 potrace_bitmap_t *ED_gpencil_trace_bitmap_new(int32_t w, int32_t h)
 {
@@ -143,7 +143,7 @@ void ED_gpencil_trace_bitmap_invert(const potrace_bitmap_t *bm)
  * Return pixel data (rgba) at index
  * \param ibuf: ImBuf of the image
  * \param idx: Index of the pixel
- * \return: RGBA value
+ * \return RGBA value
  */
 static void pixel_at_index(const ImBuf *ibuf, const int32_t idx, float r_col[4])
 {
diff --git a/source/blender/imbuf/intern/tiff.c b/source/blender/imbuf/intern/tiff.c
index 0c235445920..cd0b012d809 100644
--- a/source/blender/imbuf/intern/tiff.c
+++ b/source/blender/imbuf/intern/tiff.c
@@ -120,7 +120,7 @@ static int imb_tiff_DummyMapProc(
  * \param data: Buffer to contain data (treat as (void *)).
  * \param n: Number of bytes to read.
  *
- * \return: Number of bytes actually read.
+ * \return Number of bytes actually read.
  *   0 = EOF.
  */
 static tsize_t imb_tiff_ReadProc(thandle_t handle, tdata_t data, tsize_t n)
@@ -188,8 +188,8 @@ static tsize_t imb_tiff_WriteProc(thandle_t handle, tdata_t data, tsize_t n)
  * SEEK_END - (This is unsupported and will return -1, indicating an
  *             error).
  *
- * \return: Resulting offset location within the file, measured in bytes from
- *          the beginning of the file.  (-1) indicates an error.
+ * \return Resulting offset location within the file, measured in bytes from
+ * the beginning of the file.  (-1) indicates an error.
  */
 static toff_t imb_tiff_SeekProc(thandle_t handle, toff_t ofs, int whence)
 {
@@ -234,7 +234,7 @@ static toff_t imb_tiff_SeekProc(thandle_t handle, toff_t ofs, int whence)
  *
  * \param handle: Handle of the TIFF file (pointer to #ImbTIFFMemFile).
  *
- * \return: 0
+ * \return 0
  */
 static int imb_tiff_CloseProc(thandle_t handle)
 {
@@ -258,7 +258,7 @@ static int imb_tiff_CloseProc(thandle_t handle)
 /**
  * Returns the size of an in-memory TIFF file in bytes.
  *
- * \return: Size of file (in bytes).
+ * \return Size of file (in bytes).
  */
 static toff_t imb_tiff_SizeProc(thandle_t handle)
 {
@@ -556,7 +556,7 @@ void imb_inittiff(void)
  * \param flags: If flags has IB_test set then the file is not actually loaded,
  * but all other operations take place.
  *
- * \return: A newly allocated ImBuf structure if successful, otherwise NULL.
+ * \return A newly allocated #ImBuf structure if successful, otherwise NULL.
  */
 ImBuf *imb_loadtiff(const unsigned char *mem,
                     size_t size,
@@ -757,7 +757,7 @@ void imb_loadtiletiff(
  * \param name: Name of the TIFF file to create.
  * \param flags: Currently largely ignored.
  *
- * \return: 1 if the function is successful, 0 on failure.
+ * \return 1 if the function is successful, 0 on failure.
  */
 
 int imb_savetiff(ImBuf *ibuf, const char *filepath, int flags)