Commit: ef76a67153c9670b42f3f8091bbf41388c5bbd73 Author: Campbell Barton Date: Tue Nov 1 12:24:04 2022 +1100 Branches: master https://developer.blender.org/rBef76a67153c9670b42f3f8091bbf41388c5bbd73
Cleanup: doxy comment formatting =================================================================== M source/blender/blenkernel/BKE_bpath.h M source/blender/blenkernel/BKE_duplilist.h M source/blender/blenkernel/BKE_nla.h M source/blender/editors/space_buttons/buttons_ops.c M source/blender/editors/transform/transform_convert_nla.c M source/blender/imbuf/intern/webp.c =================================================================== diff --git a/source/blender/blenkernel/BKE_bpath.h b/source/blender/blenkernel/BKE_bpath.h index bc60b6f050e..5b1dea0833a 100644 --- a/source/blender/blenkernel/BKE_bpath.h +++ b/source/blender/blenkernel/BKE_bpath.h @@ -55,15 +55,18 @@ typedef enum eBPathForeachFlag { * This is needed for directory manipulation callbacks which might otherwise modify the same * directory multiple times. */ BKE_BPATH_FOREACH_PATH_SKIP_MULTIFILE = (1 << 8), - /** Reload data (when the path is edited). - * \note Only used by Image IDType currently. */ + /** + * Reload data (when the path is edited). + * \note Only used by Image #IDType currently. + */ BKE_BPATH_FOREACH_PATH_RELOAD_EDITED = (1 << 9), } eBPathForeachFlag; ENUM_OPERATORS(eBPathForeachFlag, BKE_BPATH_FOREACH_PATH_RELOAD_EDITED) struct BPathForeachPathData; -/** Callback used to iterate over an ID's file paths. +/** + * Callback used to iterate over an ID's file paths. * * \note `path`s parameters should be considered as having a maximal `FILE_MAX` string length. * @@ -145,8 +148,9 @@ bool BKE_bpath_foreach_path_allocated_process(struct BPathForeachPathData *bpath /** Check for missing files. */ void BKE_bpath_missing_files_check(struct Main *bmain, struct ReportList *reports); -/** Recursively search into given search directory, for all file paths of all IDs in given \a - * bmain, and replace existing paths as needed. +/** + * Recursively search into given search directory, for all file paths of all IDs in given + * \a bmain, and replace existing paths as needed. * * \note The search will happen into the whole search directory tree recursively (with a limit of * MAX_DIR_RECURSE), if several files are found matching a searched filename, the biggest one will @@ -156,7 +160,7 @@ void BKE_bpath_missing_files_check(struct Main *bmain, struct ReportList *report * \param searchpath: The root directory in which the new filepaths should be searched for. * \param find_all: If `true`, also search for files which current path is still valid, if `false` * skip those still valid paths. - * */ + */ void BKE_bpath_missing_files_find(struct Main *bmain, const char *searchpath, struct ReportList *reports, @@ -178,23 +182,28 @@ void BKE_bpath_absolute_convert(struct Main *bmain, const char *basedir, struct ReportList *reports); -/** Temp backup of paths from all IDs in given \a bmain. +/** + * Temp backup of paths from all IDs in given \a bmain. * - * \return An opaque handle to pass to #BKE_bpath_list_restore and #BKE_bpath_list_free. + * \return An opaque handle to pass to #BKE_bpath_list_restore and #BKE_bpath_list_free. */ void *BKE_bpath_list_backup(struct Main *bmain, eBPathForeachFlag flag); -/** Restore the temp backup of paths from \a path_list_handle into all IDs in given \a bmain. +/** + * Restore the temp backup of paths from \a path_list_handle into all IDs in given \a bmain. * * \note This function assumes that the data in given Main did not change (no * addition/deletion/re-ordering of IDs, or their file paths) since the call to - * #BKE_bpath_list_backup that generated the given \a path_list_handle. */ + * #BKE_bpath_list_backup that generated the given \a path_list_handle. + */ void BKE_bpath_list_restore(struct Main *bmain, eBPathForeachFlag flag, void *path_list_handle); -/** Free the temp backup of paths in \a path_list_handle. +/** + * Free the temp backup of paths in \a path_list_handle. * * \note This function assumes that the path list has already been restored with a call to - * #BKE_bpath_list_restore, and is therefore empty. */ + * #BKE_bpath_list_restore, and is therefore empty. + */ void BKE_bpath_list_free(void *path_list_handle); /** \} */ diff --git a/source/blender/blenkernel/BKE_duplilist.h b/source/blender/blenkernel/BKE_duplilist.h index 44c4df1fc2e..a0732bf39cf 100644 --- a/source/blender/blenkernel/BKE_duplilist.h +++ b/source/blender/blenkernel/BKE_duplilist.h @@ -76,16 +76,20 @@ typedef struct DupliObject { unsigned int random_id; } DupliObject; -/** Look up the RGBA value of a uniform shader attribute. - * \return true if the attribute was found; if not, r_value is also set to zero. */ +/** + * Look up the RGBA value of a uniform shader attribute. + * \return true if the attribute was found; if not, r_value is also set to zero. + */ bool BKE_object_dupli_find_rgba_attribute(struct Object *ob, struct DupliObject *dupli, struct Object *dupli_parent, const char *name, float r_value[4]); -/** Look up the RGBA value of a view layer/scene/world shader attribute. - * \return true if the attribute was found; if not, r_value is also set to zero. */ +/** + * Look up the RGBA value of a view layer/scene/world shader attribute. + * \return true if the attribute was found; if not, r_value is also set to zero. + */ bool BKE_view_layer_find_rgba_attribute(struct Scene *scene, struct ViewLayer *layer, const char *name, diff --git a/source/blender/blenkernel/BKE_nla.h b/source/blender/blenkernel/BKE_nla.h index efadd5c11d6..2913beee759 100644 --- a/source/blender/blenkernel/BKE_nla.h +++ b/source/blender/blenkernel/BKE_nla.h @@ -249,8 +249,8 @@ float BKE_nlastrip_compute_frame_to_next_strip(struct NlaStrip *strip); /** * Returns the next strip in this strip's NLA track, or a null pointer. * - * \param strip The strip to find the next trip from. - * \param check_transitions Whether or not to skip transitions. + * \param strip: The strip to find the next trip from. + * \param check_transitions: Whether or not to skip transitions. * \return The next strip in the track, or NULL if none are present. */ struct NlaStrip *BKE_nlastrip_next_in_track(struct NlaStrip *strip, bool skip_transitions); @@ -258,8 +258,8 @@ struct NlaStrip *BKE_nlastrip_next_in_track(struct NlaStrip *strip, bool skip_tr /** * Returns the previous strip in this strip's NLA track, or a null pointer. * - * \param strip The strip to find the previous trip from. - * \param check_transitions Whether or not to skip transitions. + * \param strip: The strip to find the previous trip from. + * \param check_transitions: Whether or not to skip transitions. * \return The previous strip in the track, or NULL if none are present. */ struct NlaStrip *BKE_nlastrip_prev_in_track(struct NlaStrip *strip, bool skip_transitions); diff --git a/source/blender/editors/space_buttons/buttons_ops.c b/source/blender/editors/space_buttons/buttons_ops.c index 4013288b13b..9c8d46a41f9 100644 --- a/source/blender/editors/space_buttons/buttons_ops.c +++ b/source/blender/editors/space_buttons/buttons_ops.c @@ -41,7 +41,7 @@ /* -------------------------------------------------------------------- */ /** \name Start / Clear Search Filter Operators * - * \note Almost a duplicate of the file browser operator #FILE_OT_start_filter. + * \note Almost a duplicate of the file browser operator #FILE_OT_start_filter. * \{ */ static int buttons_start_filter_exec(bContext *C, wmOperator *UNUSED(op)) diff --git a/source/blender/editors/transform/transform_convert_nla.c b/source/blender/editors/transform/transform_convert_nla.c index af5a51cbff6..830094ebe83 100644 --- a/source/blender/editors/transform/transform_convert_nla.c +++ b/source/blender/editors/transform/transform_convert_nla.c @@ -60,9 +60,9 @@ typedef struct TransDataNla { * \{ */ /** - * \brief Applies a translation to the given NlaStrip. - * \param strip_rna_ptr The RNA pointer of the NLA strip to modify. - * \param transdata The transformation info structure. + * \brief Applies a translation to the given #NlaStrip. + * \param strip_rna_ptr: The RNA pointer of the NLA strip to modify. + * \param transdata: The transformation info structure. */ static void applyTransformNLA_translation(PointerRNA *strip_rna_ptr, const TransDataNla *transdata) { diff --git a/source/blender/imbuf/intern/webp.c b/source/blender/imbuf/intern/webp.c index 27c26fb19c1..3031b8c3e33 100644 --- a/source/blender/imbuf/intern/webp.c +++ b/source/blender/imbuf/intern/webp.c @@ -1,7 +1,7 @@ /* SPDX-License-Identifier: GPL-2.0-or-later */ /** \file - * \ingroup imbuf + * \ingroup imbuf */ #ifdef _WIN32 _______________________________________________ Bf-blender-cvs mailing list Bf-blender-cvs@blender.org List details, subscription details or unsubscribe: https://lists.blender.org/mailman/listinfo/bf-blender-cvs