From 2121cc89a442841ef341899ce53c3639b7cfe2c8 Mon Sep 17 00:00:00 2001 From: Prianka Liz Kariat Date: Fri, 6 Jan 2023 13:18:48 +0530 Subject: [PATCH] Updated comments in MPPCategory --- .../containers/sources/MPPCategory.h | 50 +++++++++++-------- 1 file changed, 28 insertions(+), 22 deletions(-) diff --git a/mediapipe/tasks/ios/components/containers/sources/MPPCategory.h b/mediapipe/tasks/ios/components/containers/sources/MPPCategory.h index 035cde09d..28e89f249 100644 --- a/mediapipe/tasks/ios/components/containers/sources/MPPCategory.h +++ b/mediapipe/tasks/ios/components/containers/sources/MPPCategory.h @@ -16,41 +16,47 @@ NS_ASSUME_NONNULL_BEGIN -/** Category is a util class, contains a label, its display name, a float value as score, and the +/** + * Category is a util class that contains a label, its display name, a float value as score, and the * index of the label in the corresponding label file. Typically it's used as the result of - * classification tasks. */ + * classification tasks. + **/ NS_SWIFT_NAME(ClassificationCategory) @interface MPPCategory : NSObject -/** The index of the label in the corresponding label file. It takes the value -1 if the index is - * not set. */ +/** + * The index of the label in the corresponding label file. It takes the value -1 if the index is + * not set. + **/ @property(nonatomic, readonly) NSInteger index; -/** Confidence score for this class . */ +/** Confidence score for this class . **/ @property(nonatomic, readonly) float score; -/** The label of this category object. */ +/** The label of this category object. **/ @property(nonatomic, readonly, nullable) NSString *categoryName; -/** The display name of the label, which may be translated for different locales. For example, a - * label, "apple", may be translated into Spanish for display purpose, so that the display name is - * "manzana". */ +/** + * The display name of the label, which may be translated for different locales. For example, a + * label, "apple", may be translated into Spanish for display purpose, so that the display name is + * "manzana". + **/ @property(nonatomic, readonly, nullable) NSString *displayName; /** - * Initializes a new `MPPCategory` with the given index, score, category name and display name. - * - * @param index The index of the label in the corresponding label file. - * - * @param score The probability score of this label category. - * - * @param categoryName The label of this category object.. - * - * @param displayName The display name of the label. - * - * @return An instance of `MPPCategory` initialized with the given index, score, category name and - * display name. - */ + * Initializes a new `MPPCategory` with the given index, score, category name and display name. + * + * @param index The index of the label in the corresponding label file. + * + * @param score The probability score of this label category. + * + * @param categoryName The label of this category object. + * + * @param displayName The display name of the label. + * + * @return An instance of `MPPCategory` initialized with the given index, score, category name and + * display name. + **/ - (instancetype)initWithIndex:(NSInteger)index score:(float)score categoryName:(nullable NSString *)categoryName