Skip to content

Commit c1bf5be

Browse files
committed
Added class documentation.
1 parent 12df8a0 commit c1bf5be

File tree

4 files changed

+34
-6
lines changed

4 files changed

+34
-6
lines changed

components/Buttons/src/MDCButton.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
All buttons set the exclusiveTouch property to YES by default, which prevents users from
3030
simultaneously interacting with a button and other UI elements.
3131
32-
@see http://www.google.com/design/spec/components/buttons.html#buttons-main-buttons
32+
@see http://www.google.com/design/spec/components/buttons.html
3333
*/
3434
@interface MDCButton : UIButton
3535

components/Buttons/src/MDCFlatButton.h

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,24 @@
1818

1919
#import "MDCButton.h"
2020

21+
/**
22+
A "flat" MDCButton.
23+
24+
Flat buttons should be considered the default button. They do not have its own background color
25+
and do not raise when touched. This type of button should be used in most situations requiring a
26+
button. For layouts with many UI elements in which a flat button might get visually lost,
27+
consider using a MDCRaisedButton instead.
28+
29+
@see http://www.google.com/design/spec/components/buttons.html#buttons-flat-buttons
30+
*/
2131
@interface MDCFlatButton : MDCButton
2232

2333
/**
24-
* Use an opaque background color (default is NO).
25-
*
26-
* Flat buttons normally have a transparent background and blend seamlessly with their underlying
27-
* color, but occasionally a flat button with an opaque background will be required. Consider using
28-
* a raised button instead if possible.
34+
Use an opaque background color (default is NO).
35+
36+
Flat buttons normally have a transparent background and blend seamlessly with their underlying
37+
color, but occasionally a flat button with an opaque background will be required. Consider using
38+
a raised button instead if possible.
2939
*/
3040
@property(nonatomic) BOOL hasOpaqueBackground;
3141

components/Buttons/src/MDCFloatingButton.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,15 @@ typedef NS_ENUM(NSInteger, MDCFloatingButtonShape) {
2929
MDCFloatingButtonShapeMini
3030
};
3131

32+
/**
33+
* A "floating" MDCButton.
34+
*
35+
* Floating action buttons are circular, float a considerable amount above their parent, have
36+
* their own background color, and also raise briefly when touched. Floating action buttons should
37+
* only be used rarely, for the main action of a screen.
38+
*
39+
* @see http://www.google.com/design/spec/components/buttons.html#buttons-main-buttons
40+
*/
3241
@interface MDCFloatingButton : MDCButton
3342

3443
/**

components/Buttons/src/MDCRaisedButton.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,14 @@
1616

1717
#import "MDCButton.h"
1818

19+
/**
20+
A "raised" MDCButton.
21+
22+
Raised buttons have their own background color, float above their parent slightly, and raise
23+
briefly when touched. Raised buttons should be used when flat buttons would get lost among other
24+
UI elements on the screen.
25+
26+
@see http://www.google.com/design/spec/components/buttons.html#buttons-raised-buttons
27+
*/
1928
@interface MDCRaisedButton : MDCButton
2029
@end

0 commit comments

Comments
 (0)