Permalink
Browse files

All App Framework modules now show up on the API docs overview page.

Added `@module app` to all of the source files. Also included
`Y.App.Transitions` in the README.
  • Loading branch information...
1 parent fa96df6 commit 421945fc2bca8dfac11d6a92f5cc7933c7ca53c2 @ericf ericf committed Mar 27, 2012
View
@@ -24,6 +24,8 @@ Modules
* [`app-base`][app-base]: Provides the `Y.App` class.
+* [`app-transitions`][app-transitions]: Provides the `Y.App.Transitions` class.
+
* [`model`][model]: Provides the `Y.Model` class.
* [`model-list`][model-list]: Provides the `Y.ModelList` class.
@@ -32,9 +34,10 @@ Modules
* [`view`][view]: Provides the `Y.View` class.
-[app]: http://yuilibrary.com/yui/docs/app/
-[app-base]: http://yuilibrary.com/yui/docs/app/#app-component
-[model]: http://yuilibrary.com/yui/docs/model/
-[model-list]: http://yuilibrary.com/yui/docs/model-list/
-[router]: http://yuilibrary.com/yui/docs/router/
-[view]: http://yuilibrary.com/yui/docs/view/
+[app]: http://yuilibrary.com/yui/docs/app/
+[app-base]: http://yuilibrary.com/yui/docs/app/#app-component
+[app-transitions]: http://yuilibrary.com/yui/docs/app/#yapptransitions
+[model]: http://yuilibrary.com/yui/docs/model/
+[model-list]: http://yuilibrary.com/yui/docs/model-list/
+[router]: http://yuilibrary.com/yui/docs/router/
+[view]: http://yuilibrary.com/yui/docs/view/
View
@@ -10,6 +10,7 @@ views, and URL-based routing) for writing single-page JavaScript applications.
/**
Provides a top-level application component which manages navigation and views.
+@module app
@submodule app-base
@since 3.5.0
**/
@@ -2,9 +2,7 @@
Provides the implementation of view transitions for `Y.App.Transitions` in
browsers which support native CSS3 transitions.
-**Note:** When this module is used, `Y.App.TransitionsNative` will automatically
-mix itself in to `Y.App`.
-
+@module app
@submodule app-transitions-native
@since 3.5.0
**/
@@ -15,6 +13,9 @@ var AppTransitions = Y.App.Transitions;
Provides the implementation of view transitions for `Y.App.Transitions` in
browsers which support native CSS3 transitions.
+When this module is used, `Y.App.TransitionsNative` will automatically mix
+itself in to `Y.App`.
+
@class App.TransitionsNative
@since 3.5.0
**/
@@ -2,9 +2,7 @@
Provides view transitions for `Y.App` in browsers which support native CSS3
transitions.
-**Note:** When this module is used, `Y.App.Transitions` will automatically mix
-itself in to `Y.App`.
-
+@module app
@submodule app-transitions
@since 3.5.0
**/
View
@@ -1,6 +1,7 @@
/**
Provides an API for managing an ordered list of Model instances.
+@module app
@submodule model-list
@since 3.4.0
**/
View
@@ -2,6 +2,7 @@
Attribute-based data model with APIs for getting, setting, validating, and
syncing attribute values, as well as events for being notified of model changes.
+@module app
@submodule model
@since 3.4.0
**/
View
@@ -1,6 +1,7 @@
/**
Provides URL-based routing using HTML5 `pushState()` or the location hash.
+@module app
@submodule router
@since 3.4.0
**/
View
@@ -3,6 +3,7 @@ Represents a logical piece of an application's user interface, and provides a
lightweight, overridable API for rendering content and handling delegated DOM
events on a container element.
+@module app
@submodule view
@since 3.4.0
**/

0 comments on commit 421945f

Please sign in to comment.