docs: add documentation for fa-edge-swapper

dist/famous-angular.js

@@ -2093,8 +2093,25 @@ angular.module('famous.angular')
     };
   }]);
 
+/**
+ * @ngdoc directive
+ * @name faEdgeSwapper
+ * @module famous.angular
+ * @restrict EA
+ * @description
+ * This directive is used to hook a Famo.us EdgeSwapper into AngularJS ngAnimate events.  For example, you can apply an fa-edge-swapper directive
+ * to a `<ui-view>` or an `<ng-include>` in order to quickly and easily add EdgeSwapper transitions to template changes in those directives.
+ * Supports the `fa-options` directive for setting options.  Does NOT support sitting on the same element as another fa- elemtn
+ *
+ * @usage
+ * ```html
+ * <ui-view fa-edge-swapper></ui-view>
+ * <ng-include src='getSrc()' fa-edge-swapper></ng-include>
+ * ```
+ */
+
+
 
-//TODO:  DOCUMENT
 //TODO:  TEST
 
 angular.module('famous.angular')

docs/unstable/directive/faEdgeSwapper/index.md

@@ -0,0 +1,58 @@
+---
+layout: "docs_api"
+version: "unstable"
+versionHref: "/docs/unstable"
+path: "api/directive/faEdgeSwapper/"
+title: "fa-edge-swapper"
+header_sub_title: "Directive in module famous.angular"
+doc: "faEdgeSwapper"
+docType: "directive"
+---
+
+<div class="improve-docs">
+  <a href='https://github.com/Famous/famous-angular/edit/master/src/scripts/directives/fa-edge-swapper.js#L1'>
+    Improve this doc
+  </a>
+</div>
+
+
+
+
+
+<h1 class="api-title">
+
+  fa-edge-swapper
+
+
+
+</h1>
+
+
+
+
+
+This directive is used to hook a Famo.us EdgeSwapper into AngularJS ngAnimate events.  For example, you can apply an fa-edge-swapper directive
+to a `<ui-view>` or an `<ng-include>` in order to quickly and easily add EdgeSwapper transitions to template changes in those directives.
+Supports the `fa-options` directive for setting options.  Does NOT support sitting on the same element as another fa- elemtn
+
+
+
+
+
+
+
+<h2 id="usage">Usage</h2>
+
+```html
+<ui-view fa-edge-swapper></ui-view>
+<ng-include src='getSrc()' fa-edge-swapper></ng-include>
+```
+
+
+
+
+
+
+
+
+

docs/unstable/service/$famous/index.md

@@ -10,7 +10,7 @@ docType: "service"
 ---
 
 <div class="improve-docs">
-  <a href='https://github.com/Famous/famous-angular/edit/master/src/scripts/services/famous.js#L241'>
+  <a href='https://github.com/Famous/famous-angular/edit/master/src/scripts/services/famous.js#L250'>
     Improve this doc
   </a>
 </div>

src/scripts/directives/fa-edge-swapper.js

@@ -1,5 +1,22 @@
+/**
+ * @ngdoc directive
+ * @name faEdgeSwapper
+ * @module famous.angular
+ * @restrict EA
+ * @description
+ * This directive is used to hook a Famo.us EdgeSwapper into AngularJS ngAnimate events.  For example, you can apply an fa-edge-swapper directive
+ * to a `<ui-view>` or an `<ng-include>` in order to quickly and easily add EdgeSwapper transitions to template changes in those directives.
+ * Supports the `fa-options` directive for setting options.  Does NOT support sitting on the same element as another fa- elemtn
+ *
+ * @usage
+ * ```html
+ * <ui-view fa-edge-swapper></ui-view>
+ * <ng-include src='getSrc()' fa-edge-swapper></ng-include>
+ * ```
+ */
+
+
 
-//TODO:  DOCUMENT
 //TODO:  TEST
 
 angular.module('famous.angular')