[Buttons] Add documentation for Enums.

PiperOrigin-RevId: 353292772
material-components · Jan 22, 2021 · c727b89 · c727b89
1 parent d5bba14
commit c727b89
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git 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
@@ -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.