Merge pull request #15716 from toddjordan/rfc-176-part-duex

[DOC Canary] Yuidoc annotation changes for rfc 176

packages/ember-application/lib/index.js

@@ -1,7 +1,3 @@
-/**
-@module ember
-@submodule ember-application
-*/
 
 export { default as Application } from './system/application';
 export { default as ApplicationInstance } from './system/application-instance';

packages/ember-application/lib/system/application-instance.js

@@ -1,6 +1,5 @@
 /**
-@module ember
-@submodule ember-application
+@module @ember/application
 */
 
 import { assign } from 'ember-utils';
@@ -34,15 +33,15 @@ import EngineInstance from './engine-instance';
   it once the particular test run or FastBoot request has finished.
 
   @public
-  @class Ember.ApplicationInstance
-  @extends Ember.EngineInstance
+  @class ApplicationInstance
+  @extends EngineInstance
 */
 
 const ApplicationInstance = EngineInstance.extend({
   /**
     The `Application` for which this is an instance.
 
-    @property {Ember.Application} application
+    @property {Application} application
     @private
   */
   application: null,
@@ -231,7 +230,7 @@ const ApplicationInstance = EngineInstance.extend({
 
     @public
     @param url {String} the destination URL
-    @return {Promise<Ember.ApplicationInstance>}
+    @return {Promise<ApplicationInstance>}
   */
   visit(url) {
     this.setupRouter();
@@ -316,7 +315,7 @@ ApplicationInstance.reopenClass({
   Internal, experimental or otherwise unstable flags are marked as private.
 
   @class BootOptions
-  @namespace Ember.ApplicationInstance
+  @namespace ApplicationInstance
   @public
 */
 function BootOptions(options = {}) {

packages/ember-application/lib/system/application.js

@@ -1,6 +1,5 @@
 /**
-@module ember
-@submodule ember-application
+@module @ember/application
 */
 import { dictionary } from 'ember-utils';
 import { ENV, environment } from 'ember-environment';
@@ -188,8 +187,7 @@ let librariesRegistered = false;
   begins.
 
   @class Application
-  @namespace Ember
-  @extends Ember.Engine
+  @extends Engine
   @uses RegistryProxyMixin
   @public
 */
@@ -366,7 +364,7 @@ const Application = Engine.extend({
 
     @private
     @method buildInstance
-    @return {Ember.ApplicationInstance} the application instance
+    @return {ApplicationInstance} the application instance
   */
   buildInstance(options = {}) {
     options.base = this;
@@ -523,7 +521,7 @@ const Application = Engine.extend({
     or the application will never become ready and routing will not begin.
 
     @method advanceReadiness
-    @see {Ember.Application#deferReadiness}
+    @see {Application#deferReadiness}
     @public
   */
   advanceReadiness() {
@@ -549,7 +547,7 @@ const Application = Engine.extend({
 
     @private
     @method boot
-    @return {Promise<Ember.Application,Error>}
+    @return {Promise<Application,Error>}
   */
   boot() {
     if (this._bootPromise) { return this._bootPromise; }
@@ -963,8 +961,8 @@ const Application = Engine.extend({
     @public
     @method visit
     @param url {String} The initial URL to navigate to
-    @param options {Ember.ApplicationInstance.BootOptions}
-    @return {Promise<Ember.ApplicationInstance, Error>}
+    @param options {ApplicationInstance.BootOptions}
+    @return {Promise<ApplicationInstance, Error>}
   */
   visit(url, options) {
     return this.boot().then(() => {
@@ -1009,7 +1007,7 @@ Application.reopenClass({
 
     @method buildRegistry
     @static
-    @param {Ember.Application} namespace the application for which to
+    @param {Application} namespace the application for which to
       build the registry
     @return {Ember.Registry} the built registry
     @private

packages/ember-application/lib/system/engine-instance.js

@@ -1,6 +1,5 @@
 /**
-@module ember
-@submodule ember-application
+@module @ember/engine
 */
 
 import { guidFor } from 'ember-utils';
@@ -20,8 +19,8 @@ import { getEngineParent, setEngineParent } from './engine-parent';
   running `Engine`.
 
   @public
-  @class Ember.EngineInstance
-  @extends Ember.Object
+  @class EngineInstance
+  @extends EmberObject
   @uses RegistryProxyMixin
   @uses ContainerProxyMixin
 */
@@ -139,7 +138,7 @@ const EngineInstance = EmberObject.extend(RegistryProxyMixin, ContainerProxyMixi
     @method buildChildEngineInstance
     @param name {String} the registered name of the engine.
     @param options {Object} options provided to the engine instance.
-    @return {Ember.EngineInstance,Error}
+    @return {EngineInstance,Error}
   */
   buildChildEngineInstance(name, options = {}) {
     let Engine = this.lookup(`engine:${name}`);

packages/ember-application/lib/system/engine-parent.js

@@ -8,7 +8,8 @@ export const ENGINE_PARENT = symbol('ENGINE_PARENT');
   @method getEngineParent
   @param {EngineInstance} engine An engine instance.
   @return {EngineInstance} The parent engine instance.
-  @for Ember
+  @for @ember/engine
+  @static
   @private
 */
 export function getEngineParent(engine) {

packages/ember-application/lib/system/engine.js

@@ -1,6 +1,5 @@
 /**
-@module ember
-@submodule ember-application
+@module @ember/engine
 */
 import { canInvoke } from 'ember-utils';
 import {
@@ -44,7 +43,6 @@ function props(obj) {
   Engines can spawn `EngineInstance` instances via `buildInstance()`.
 
   @class Engine
-  @namespace Ember
   @extends Ember.Namespace
   @uses RegistryProxy
   @public
@@ -82,7 +80,7 @@ const Engine = Namespace.extend(RegistryProxyMixin, {
 
     @private
     @method buildInstance
-    @return {Ember.EngineInstance} the engine instance
+    @return {EngineInstance} the engine instance
   */
   buildInstance(options = {}) {
     this.ensureInitializers();
@@ -413,7 +411,7 @@ Engine.reopenClass({
 
     @method buildRegistry
     @static
-    @param {Ember.Application} namespace the application for which to
+    @param {Application} namespace the application for which to
       build the registry
     @return {Ember.Registry} the built registry
     @private

packages/ember-application/lib/system/resolver.js

@@ -1,6 +1,5 @@
- /**
-@module ember
-@submodule ember-application
+/**
+@module @ember/application
 */
 
 import { dictionary } from 'ember-utils';
@@ -79,32 +78,25 @@ export const Resolver = EmberObject.extend({
 
   Some examples of how names are resolved:
 
-  ```
+  ```text
   'template:post'           //=> Ember.TEMPLATES['post']
   'template:posts/byline'   //=> Ember.TEMPLATES['posts/byline']
   'template:posts.byline'   //=> Ember.TEMPLATES['posts/byline']
-  'template:blogPost'       //=> Ember.TEMPLATES['blogPost']
-                            //   OR
-                            //   Ember.TEMPLATES['blog_post']
+  'template:blogPost'       //=> Ember.TEMPLATES['blog-post']
   'controller:post'         //=> App.PostController
   'controller:posts.index'  //=> App.PostsIndexController
   'controller:blog/post'    //=> Blog.PostController
-  'controller:basic'        //=> Ember.Controller
+  'controller:basic'        //=> Controller
   'route:post'              //=> App.PostRoute
   'route:posts.index'       //=> App.PostsIndexRoute
   'route:blog/post'         //=> Blog.PostRoute
-  'route:basic'             //=> Ember.Route
-  'view:post'               //=> App.PostView
-  'view:posts.index'        //=> App.PostsIndexView
-  'view:blog/post'          //=> Blog.PostView
-  'view:basic'              //=> Ember.View
+  'route:basic'             //=> Route
   'foo:post'                //=> App.PostFoo
   'model:post'              //=> App.Post
   ```
 
-  @class DefaultResolver
-  @namespace Ember
-  @extends Ember.Object
+  @class GlobalsResolver
+  @extends EmberObject
   @public
 */
 

packages/ember-application/lib/utils/validate-type.js

@@ -1,8 +1,3 @@
-/**
-@module ember
-@submodule ember-application
-*/
-
 import { assert, deprecate } from 'ember-debug';
 
 const VALIDATED_TYPES = {

packages/ember-debug/lib/deprecate.js

@@ -7,12 +7,10 @@ import Logger from 'ember-console';
 import { ENV } from 'ember-environment';
 
 import { registerHandler as genericRegisterHandler, invoke } from './handlers';
-
 /**
-@module ember
-@submodule ember-debug
+ @module @ember/debug
+ @public
 */
-
 /**
   Allows for runtime registration of handler functions that override the default deprecation behavior.
   Deprecations are invoked by calls to [Ember.deprecate](https://emberjs.com/api/classes/Ember.html#method_deprecate).
@@ -45,7 +43,7 @@ import { registerHandler as genericRegisterHandler, invoke } from './handlers';
   @public
   @static
   @method registerDeprecationHandler
-  @for Ember.Debug
+  @for @ember/debug
   @param handler {Function} A function to handle deprecation calls.
   @since 2.1.0
 */
@@ -132,7 +130,10 @@ if (DEBUG) {
     '`options` should include `id` and `until` properties.';
   missingOptionsIdDeprecation = 'When calling `Ember.deprecate` you must provide `id` in options.';
   missingOptionsUntilDeprecation = 'When calling `Ember.deprecate` you must provide `until` in options.';
-
+  /**
+   @module @ember/application
+   @public
+   */
   /**
     Display a deprecation warning with the provided message and a stack trace
     (Chrome and Firefox only).
@@ -141,6 +142,7 @@ if (DEBUG) {
     Uses of this method in Ember itself are stripped from the ember.prod.js build.
 
     @method deprecate
+    @for @ember/application/deprecations
     @param {String} message A description of the deprecation.
     @param {Boolean} test A boolean. If falsy, the deprecation will be displayed.
     @param {Object} options
@@ -152,7 +154,7 @@ if (DEBUG) {
       warning will be removed.
     @param {String} [options.url] An optional url to the transition guide on the
       emberjs.com website.
-    @for Ember
+    @static
     @public
     @since 1.0.0
   */

packages/ember-debug/lib/error.js

@@ -1,4 +1,6 @@
-
+/**
+ @module @ember/error
+*/
 function ExtendBuiltin(klass) {
   function ExtendableBuiltin() {
     klass.apply(this, arguments);
@@ -12,8 +14,7 @@ function ExtendBuiltin(klass) {
 /**
   A subclass of the JavaScript Error object for use in Ember.
 
-  @class Error
-  @namespace Ember
+  @class EmberError
   @extends Error
   @constructor
   @public

packages/ember-debug/lib/features.js

@@ -2,6 +2,10 @@ import { ENV } from 'ember-environment';
 import * as FLAGS from 'ember/features';
 let { FEATURES } = FLAGS;
 
+/**
+ @module ember
+*/
+
 /**
   The hash of enabled Canary features. Add to this, any canary features
   before creating your application.