diff options
author | Campbell Barton <campbell@blender.org> | 2022-04-11 08:42:28 +0300 |
---|---|---|
committer | Campbell Barton <campbell@blender.org> | 2022-04-11 08:42:28 +0300 |
commit | e03810693c06a09ba570a957af52cce9a6d3cbe3 (patch) | |
tree | 3e278ffea94547722af01254212c448ac1ed2810 /source/blender/blenkernel/BKE_image.h | |
parent | 5e47056e8d97e414c9dabacea71fac2bdc7d2818 (diff) |
Cleanup: use doxy-comments and `r_` prefix return arguments
Diffstat (limited to 'source/blender/blenkernel/BKE_image.h')
-rw-r--r-- | source/blender/blenkernel/BKE_image.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/source/blender/blenkernel/BKE_image.h b/source/blender/blenkernel/BKE_image.h index fba2512fa49..fff3b2a8f89 100644 --- a/source/blender/blenkernel/BKE_image.h +++ b/source/blender/blenkernel/BKE_image.h @@ -329,7 +329,7 @@ void BKE_image_merge(struct Main *bmain, struct Image *dest, struct Image *sourc bool BKE_image_scale(struct Image *image, int width, int height); /** - * Check if texture has alpha (planes == 32 || planes == 16). + * Check if texture has alpha `planes == 32 || planes == 16`. */ bool BKE_image_has_alpha(struct Image *image); @@ -350,13 +350,13 @@ void BKE_image_get_tile_label(struct Image *ima, * Checks whether the given filepath refers to a UDIM tiled texture. * If yes, the range from the lowest to the highest tile is returned. * - * `filepath` may be modified to ensure a UDIM token is present. - * `tiles` may be filled even if the result ultimately is false! + * \param filepath: may be modified to ensure a UDIM token is present. + * \param tiles: may be filled even if the result ultimately is false! */ bool BKE_image_get_tile_info(char *filepath, struct ListBase *tiles, - int *tile_start, - int *tile_range); + int *r_tile_start, + int *r_tile_range); struct ImageTile *BKE_image_add_tile(struct Image *ima, int tile_number, const char *label); bool BKE_image_remove_tile(struct Image *ima, struct ImageTile *tile); @@ -385,7 +385,7 @@ typedef enum { void BKE_image_ensure_tile_token(char *filename); /** - * When provided with an absolute virtual filepath, check to see if at least + * When provided with an absolute virtual `filepath`, check to see if at least * one concrete file exists. * Note: This function requires directory traversal and may be inefficient in time-critical, * or iterative, code paths. @@ -394,8 +394,8 @@ bool BKE_image_tile_filepath_exists(const char *filepath); /** * Retrieves the UDIM token format and returns the pattern from the provided `filepath`. - * The returned pattern is typically passed to either `BKE_image_get_tile_number_from_filepath` or - * `BKE_image_set_filepath_from_tile_number`. + * The returned pattern is typically passed to either #BKE_image_get_tile_number_from_filepath or + * #BKE_image_set_filepath_from_tile_number. */ char *BKE_image_get_tile_strformat(const char *filepath, eUDIM_TILE_FORMAT *r_tile_format); bool BKE_image_get_tile_number_from_filepath(const char *filepath, |