[Themes] Add deprecation notice to APIs and remove from the site. (#3636

) Pivotal story: https://www.pivotaltracker.com/story/show/157238864
material-components · May 2, 2018 · cd3a53c · cd3a53c
1 parent f636a9c
commit cd3a53c
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 10 deletions.
diff --git a/components/Themes/README.md b/components/Themes/README.md
@@ -1,15 +1,11 @@
-<!--docs:
-title: "Themes"
-layout: detail
-section: components
-excerpt: "Themes provides a mechanism to colorize components with color schemes."
-icon_id: themes
-path: /catalog/themes/
-api_doc_root: true
--->
-
 # Themes
 
+*Notice*: This component will soon be deprecated. Please consider using the
+[schemes/Typography](../schemes/Typography) and [schemes/Color](../schemes/Color) components and
+the [Material Theming](../../docs/theming) APIs instead.
+
+---
+
 <div class="article__asset article__asset--screenshot">
   <img src="docs/assets/themes.png" alt="Themes" width="375">
 </div>

diff --git a/components/schemes/Color/src/MDCLegacyColorScheme.h b/components/schemes/Color/src/MDCLegacyColorScheme.h
@@ -16,9 +16,13 @@
 
 #import <UIKit/UIKit.h>
 
+#pragma mark - Soon to be deprecated
+
 /**
  A color scheme comprised of set of primary and secondary colors. Material design guidelines
  recommend using primary and secondary colors with light and dark color variants.
+
+ @warning This class will soon be deprecated. Consider using MDCColorScheming instead.
  */
 @protocol MDCColorScheme <NSObject>
 
@@ -59,6 +63,8 @@
 /**
  A basic color scheme comprised of set of primary and secondary colors with light and dark color
  variants.
+
+ @warning This class will soon be deprecated. Consider using MDCSemanticColorScheme instead.
  */
 @interface MDCBasicColorScheme : NSObject <MDCColorScheme, NSCopying>
 

diff --git a/components/schemes/Color/src/MDCLegacyTonalColorScheme.h b/components/schemes/Color/src/MDCLegacyTonalColorScheme.h
@@ -20,9 +20,13 @@
 
 @class MDCTonalPalette;
 
+#pragma mark - Soon to be deprecated
+
 /**
  A tonal color scheme is a color scheme based on a primary tonal color palette and secondary tonal
  color palette. The tonal color palettes are used for the color scheme color properties.
+
+ @warning This class will soon be deprecated. Consider using MDCColorScheming instead.
  */
 @interface MDCTonalColorScheme : NSObject <MDCColorScheme, NSCopying>
 

diff --git a/components/schemes/Typography/src/MDCLegacyFontScheme.h b/components/schemes/Typography/src/MDCLegacyFontScheme.h
@@ -16,13 +16,17 @@
 
 #import <UIKit/UIKit.h>
 
+#pragma mark - Soon to be deprecated
+
 /**
  A font scheme comprised of set of UIFonts that are associated with various text styles.
 
  By apply the scheme to various components using themers one can set fonts on a single instance
  of a components.
 
  If a font in a scheme is nil, a component should use its default font.
+
+ @warning This class will soon be deprecated. Consider using MDCTypographyScheming instead.
  */
 @protocol MDCFontScheme <NSObject>
 
@@ -69,6 +73,8 @@
 
 /**
  A basic font scheme implements the MDCFontScheme protocol.
+
+ @warning This class will soon be deprecated. Consider using MDCTypographyScheme instead.
  */
 @interface MDCBasicFontScheme : NSObject <MDCFontScheme>