feat: deprecate fa-animation

Famous · Aug 4, 2014 · e50d353 · e50d353
1 parent 515793b
commit e50d353
Show file tree

Hide file tree

Showing 34 changed files with 125 additions and 74 deletions.
diff --git a/dist/famous-angular.js b/dist/famous-angular.js
@@ -846,8 +846,8 @@ angular.module('famous.angular')
  * @module famous.angular
  * @restrict EA
  * @description
- * This directive is used to animate an element in conjunction with an {@link api/directive/animate animate} directive
- *
+ * This directive is deprecated.  Prefer using the $timeline service.  This directive is used to animate an element in conjunction with an {@link api/directive/animate animate} directive
+ * @deprecated true
  * @usage
  * ```html
  * <fa-animation timeline="functionThatReturnsATimelineValueBetween0And1">
@@ -1165,8 +1165,9 @@ angular.module('famous.angular')
                * @name animate
                * @module famous.angular
                * @restrict E
+               * @deprecated true
                * @description
-               * This element is used to specify the animation of an element in a {@link api/directive/faAnimation faAnimation} directive
+               * This directive is deprecated.  Prefer using the $timeline service.  This element is used to specify the animation of an element in a {@link api/directive/faAnimation faAnimation} directive
                *
                * @usage
                * ```html

diff --git a/docs-generation/templates/api/api.template.html b/docs-generation/templates/api/api.template.html
@@ -11,6 +11,10 @@
     Improve this doc
   </a>
 </div>
+<@ if doc.deprecated @>
+  <br>
+  <strong>This <$ doc.docType $> is deprecated.</strong>
+<@ endif @>
 
 <@ block content @>
 
@@ -44,13 +48,6 @@ <h1 class="api-title">
 <$ doc.description $>
 <@ endblock @>
 
-<@ if doc.deprecated @>
-<fieldset class="deprecated">
-  <legend>Deprecated API</legend>
-  <$ doc.deprecated| marked $>
-</fieldset>
-<@ endif @>
-
 <@ block dependencies @>
 <@- if doc.requires @>
 <h2 id="dependencies">Dependencies</h2>

diff --git a/docs/unstable/directive/animate/index.md b/docs/unstable/directive/animate/index.md
@@ -15,6 +15,10 @@ docType: "directive"
   </a>
 </div>
 
+  <br>
+  <strong>This directive is deprecated.</strong>
+
+
 
 
 
@@ -30,9 +34,7 @@ docType: "directive"
 
 
 
-This element is used to specify the animation of an element in a <a href="api/directive/faAnimation">faAnimation</a> directive
-
-
+This directive is deprecated.  Prefer using the $timeline service.  This element is used to specify the animation of an element in a <a href="api/directive/faAnimation">faAnimation</a> directive
 
 
 

diff --git a/docs/unstable/directive/faAnimation/index.md b/docs/unstable/directive/faAnimation/index.md
@@ -15,6 +15,10 @@ docType: "directive"
   </a>
 </div>
 
+  <br>
+  <strong>This directive is deprecated.</strong>
+
+
 
 
 
@@ -30,9 +34,7 @@ docType: "directive"
 
 
 
-This directive is used to animate an element in conjunction with an <a href="api/directive/animate">animate</a> directive
-
-
+This directive is deprecated.  Prefer using the $timeline service.  This directive is used to animate an element in conjunction with an <a href="api/directive/animate">animate</a> directive
 
 
 

diff --git a/docs/unstable/directive/faApp/index.md b/docs/unstable/directive/faApp/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-app
@@ -41,8 +42,6 @@ it is inside of a <a href="api/directive/faSurface">fa-surface</a> directive.
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faCanvasSurface/index.md b/docs/unstable/directive/faCanvasSurface/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-canvas-surface
@@ -37,8 +38,6 @@ This directive creates a Famo.us CanvasSurface.
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faClick/index.md b/docs/unstable/directive/faClick/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-click
@@ -37,8 +38,6 @@ This directive allows you to specify custom behavior when an element is clicked.
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faContainerSurface/index.md b/docs/unstable/directive/faContainerSurface/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-container-surface
@@ -40,8 +41,6 @@ constructor.  See [https://famo.us/docs/surfaces/ContainerSurface]
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faFlexibleLayout/index.md b/docs/unstable/directive/faFlexibleLayout/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-flexible-layout
@@ -40,8 +41,6 @@ constructor. See [https://famo.us/docs/views/FlexibleLayout]
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faFlipper/index.md b/docs/unstable/directive/faFlipper/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-flipper
@@ -40,8 +41,6 @@ constructor.  See [https://famo.us/docs/views/Flipper]
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faGridLayout/index.md b/docs/unstable/directive/faGridLayout/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-grid-layout
@@ -40,8 +41,6 @@ constructor.  See [https://famo.us/docs/views/GridLayout]
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faHeaderFooterLayout/index.md b/docs/unstable/directive/faHeaderFooterLayout/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-header-footer-layout
@@ -39,8 +40,6 @@ a Header, Content, and Footer based on the order of its child elements.
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faImageSurface/index.md b/docs/unstable/directive/faImageSurface/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-image-surface
@@ -38,8 +39,6 @@ the specified ImageUrl.
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faIndex/index.md b/docs/unstable/directive/faIndex/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-index
@@ -43,8 +44,6 @@ order is desired, then the index value must be assigned/overridden using the faI
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faModifier/index.md b/docs/unstable/directive/faModifier/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-modifier
@@ -38,8 +39,6 @@ to values (e.g. `fa-translate="[15, 20, 1]"`, Famo.us Transitionable objects, or
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faPipeFrom/index.md b/docs/unstable/directive/faPipeFrom/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-pipe-from
@@ -37,8 +38,6 @@ This directive pipes a target event handler to an element's event handler.
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faPipeTo/index.md b/docs/unstable/directive/faPipeTo/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-pipe-to
@@ -37,8 +38,6 @@ This directive pipes an element's event handler to a source event handler.
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faRenderNode/index.md b/docs/unstable/directive/faRenderNode/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-render-node
@@ -39,8 +40,6 @@ It allows you to pass a reference to an arbitrary render node from your controll
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faScrollView/index.md b/docs/unstable/directive/faScrollView/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-scroll-view
@@ -39,8 +40,6 @@ and will allow you to scroll through them with mousewheel or touch events.
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faSequentialLayout/index.md b/docs/unstable/directive/faSequentialLayout/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-sequential-layout
@@ -40,8 +41,6 @@ constructor.  See [https://famo.us/docs/views/SequentialLayout]
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faSurface/index.md b/docs/unstable/directive/faSurface/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-surface
@@ -43,8 +44,6 @@ ngIncludes or custom (vanilla Angular) directives.
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>
 

diff --git a/docs/unstable/directive/faTap/index.md b/docs/unstable/directive/faTap/index.md
@@ -18,6 +18,7 @@ docType: "directive"
 
 
 
+
 <h1 class="api-title">
 
   fa-tap
@@ -37,8 +38,6 @@ This directive allows you to specify custom behavior when an element is tapped.
 
 
 
-
-
 
 <h2 id="usage">Usage</h2>