From c727b890df3c0766706ad8000649f7733cdef997 Mon Sep 17 00:00:00 2001 From: Cody Weaver Date: Fri, 22 Jan 2021 12:11:43 -0800 Subject: [PATCH] [Buttons] Add documentation for Enums. PiperOrigin-RevId: 353292772 --- components/Buttons/src/MDCFloatingButton+Animation.h | 4 ++++ components/Buttons/src/MDCFloatingButton.h | 11 +++++++++++ 2 files changed, 15 insertions(+) diff --git a/components/Buttons/src/MDCFloatingButton+Animation.h b/components/Buttons/src/MDCFloatingButton+Animation.h index 5b9c53d1689..8b7a360e312 100644 --- a/components/Buttons/src/MDCFloatingButton+Animation.h +++ b/components/Buttons/src/MDCFloatingButton+Animation.h @@ -14,6 +14,10 @@ #import "MDCFloatingButton.h" +/** + This category is used to animate @c MDCFloatingButton instances, to expand or + collapse. + */ @interface MDCFloatingButton (Animation) /** diff --git a/components/Buttons/src/MDCFloatingButton.h b/components/Buttons/src/MDCFloatingButton.h index e23e9e69035..a76414c4f02 100644 --- a/components/Buttons/src/MDCFloatingButton.h +++ b/components/Buttons/src/MDCFloatingButton.h @@ -34,6 +34,11 @@ typedef NS_ENUM(NSInteger, MDCFloatingButtonShape) { MDCFloatingButtonShapeMini = 1 }; +/** + Size of Material Floating button. + + The expanded mode should only be used when text and an icon are used. + */ typedef NS_ENUM(NSInteger, MDCFloatingButtonMode) { /** The floating button is a circle with its contents centered. @@ -46,6 +51,12 @@ typedef NS_ENUM(NSInteger, MDCFloatingButtonMode) { MDCFloatingButtonModeExpanded = 1, }; +/** + Image location of Material Floating button. + + If the button is @c MDCFloatingButtonModeExpanded this determines where the + text is rendered in relation to the icon. + */ typedef NS_ENUM(NSInteger, MDCFloatingButtonImageLocation) { /** The image of the floating button is on the leading side of the title.