Merge pull request emberjs#1335 from wagenet/yuidoc

First pass at YUIDoc conversion

Author: wagenet

.gitignore

@@ -16,7 +16,8 @@ assets/bpm_styles.css
 bin/
 coverage
 dist
-docs
+docs/build
+docs/node_modules
 lib/*/tests/all.js
 lib/*/tests/qunit*
 lib/bundler/man

Gemfile

@@ -9,6 +9,5 @@ gem "uglifier", :git => "https://github.com/lautis/uglifier.git"
 group :development do
   gem "rack"
   gem "github_downloads", :git => "https://github.com/pangratz/github_downloads.git"
-  gem "ember-docs", :git => "https://github.com/emberjs/docs-generator.git"
   gem "kicker"
 end

Gemfile.lock

@@ -1,11 +1,3 @@
-GIT
-  remote: https://github.com/emberjs/docs-generator.git
-  revision: cfbc2a3aabc08de305224b290ad8f37f3ef5f847
-  specs:
-    ember-docs (0.1)
-      rack
-      thor
-
 GIT
   remote: https://github.com/lautis/uglifier.git
   revision: 45133bfdadc8f5056cb93423d2eedad3aed936bf
@@ -80,7 +72,6 @@ PLATFORMS
 
 DEPENDENCIES
   colored
-  ember-docs!
   github_downloads!
   kicker
   rack

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Yehuda Katz, Tom Dale, Charles Jolley and Ember.js contributors
+Copyright (c) 2012 Yehuda Katz, Tom Dale, Charles Jolley and Ember.js contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

Rakefile

@@ -26,43 +26,6 @@ def upload_file(uploader, filename, description, file)
   end
 end
 
-def docs_upload_task(name)
-  instance_eval <<-end_eval
-    namespace :upload do
-      file "tmp/#{name}" do
-        mkdir_p "tmp"
-
-        Dir.chdir("tmp") do
-          sh "git clone [email protected]:#{name}.git"
-        end
-      end
-
-      task :pull => "tmp/#{name}" do
-        Dir.chdir("tmp/#{name}") do
-          sh "git pull origin master"
-        end
-      end
-
-      task :clean => :pull do
-        rm_rf "tmp/#{name}/html"
-      end
-
-      file "tmp/#{name}/html" => ['docs:build', :clean] do
-        cp_r "docs", "tmp/#{name}/html"
-      end
-
-      task :run => "tmp/#{name}/html" do
-        Dir.chdir "tmp/#{name}" do
-          sh "git add -A html && git commit -m 'Upload generated API docs' && git push origin master"
-        end
-      end
-    end
-
-    desc "Upload docs to #{name}"
-    task :upload => 'upload:run'
-  end_eval
-end
-
 
 desc "Strip trailing whitespace for JavaScript files in packages"
 task :strip_whitespace do
@@ -99,31 +62,6 @@ task :upload_latest => [:clean, :dist] do
   upload_file(uploader, 'ember-latest.js', "Ember.js Master", "dist/ember.js")
 end
 
-namespace :docs do
-  def doc_args
-    "#{Dir.glob("packages/ember-*").join(' ')} -E #{Dir.glob("packages/ember-*/tests").join(' ')} -t docs.emberjs.com"
-  end
-
-  desc "Preview Ember Docs (does not auto update)"
-  task :preview do
-    require "ember_docs/cli"
-    EmberDocs::CLI.start("preview #{doc_args}".split(' '))
-  end
-
-  desc "Build Ember Docs"
-  task :build do
-    require "ember_docs/cli"
-    EmberDocs::CLI.start("generate #{doc_args} -o docs".split(' '))
-  end
-
-  docs_upload_task("ember-edge-docs")
-
-  desc "Remove Ember Docs"
-  task :clean do
-    rm_r "docs"
-  end
-end
-
 desc "Run tests with phantomjs"
 task :test, [:suite] => :dist do |t, args|
   require "colored"
@@ -519,21 +457,11 @@ namespace :release do
     task :deploy => [:update]
   end
 
-  namespace :docs do
-    docs_upload_task("ember-docs")
-
-    desc "Prepare docs for release"
-    task :prepare => []
-
-    desc "Deploy docs"
-    task :deploy => [:upload]
-  end
-
   desc "Prepare Ember for new release"
-  task :prepare => [:clean, 'framework:prepare', 'starter_kit:prepare', 'examples:prepare', 'website:prepare', 'docs:prepare']
+  task :prepare => [:clean, 'framework:prepare', 'starter_kit:prepare', 'examples:prepare', 'website:prepare']
 
   desc "Deploy a new Ember release"
-  task :deploy => ['framework:deploy', 'starter_kit:deploy', 'examples:deploy', 'website:deploy', 'docs:deploy']
+  task :deploy => ['framework:deploy', 'starter_kit:deploy', 'examples:deploy', 'website:deploy']
 
 end
 

docs/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "ember-docs",
+  "version": "0.0.1",
+  "dependencies": {
+    "yuidoc": "git://github.com/wagenet/yuidoc.git"
+  }
+}

docs/yuidoc.json

@@ -0,0 +1,20 @@
+{
+  "name": "The Ember API",
+  "description": "The Ember API: a framework for building ambitious web applications",
+  "version": "1.0 pre",
+  "url": "http://emberjs.com/",
+  "options": {
+    "paths": [
+      "../packages/ember/lib",
+      "../packages/ember-debug/lib",
+      "../packages/ember-metal/lib",
+      "../packages/ember-runtime/lib",
+      "../packages/ember-states/lib",
+      "../packages/ember-views/lib",
+      "../packages/ember-handlebars/lib",
+      "../packages/ember-routing/lib",
+      "../packages/ember-application/lib"
+    ],
+    "outdir":   "./build"
+  }
+}

generators/license.js

@@ -3,5 +3,6 @@
 // Copyright: ©2011-2012 Tilde Inc. and contributors
 //            Portions ©2006-2011 Strobe Inc.
 //            Portions ©2008-2011 Apple Inc. All rights reserved.
-// License:   Licensed under MIT license (see license.js)
+// License:   Licensed under MIT license
+//            See https://raw.github.com/emberjs/ember.js/master/LICENSE
 // ==========================================================================

packages/ember-application/lib/main.js

@@ -2,3 +2,11 @@ require('ember-views');
 require('ember-states');
 require('ember-routing');
 require('ember-application/system');
+
+/**
+Ember Application
+
+@module ember
+@submodule ember-application
+@requires ember-views, ember-states, ember-routing
+*/

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

@@ -1,15 +1,11 @@
-// ==========================================================================
-// Project:   Ember - JavaScript Application Framework
-// Copyright: ©2006-2011 Strobe Inc. and contributors.
-//            Portions ©2008-2011 Apple Inc. All rights reserved.
-// License:   Licensed under MIT license (see license.js)
-// ==========================================================================
+/**
+@module ember
+@submodule ember-application
+*/
 
 var get = Ember.get, set = Ember.set;
 
 /**
-  @class
-
   An instance of `Ember.Application` is the starting point for every Ember.js
   application. It helps to instantiate, initialize and coordinate the many
   objects that make up your app.
@@ -184,6 +180,8 @@ var get = Ember.get, set = Ember.set;
   App.ApplicationController = Ember.Controller.extend();
   ```
 
+  @class Application
+  @namespace Ember
   @extends Ember.Namespace
 */
 Ember.Application = Ember.Namespace.extend(
@@ -198,6 +196,7 @@ Ember.Application = Ember.Namespace.extend(
     `eventDispatcher`, which sets up the listeners for event delegation. Every
     view in your application should be a child of the element you specify here.
 
+    @property rootElement
     @type DOMElement
     @default 'body'
   */
@@ -213,6 +212,7 @@ Ember.Application = Ember.Namespace.extend(
 
     See the documentation for `Ember.EventDispatcher` for more information.
 
+    @property eventDispatcher
     @type Ember.EventDispatcher
     @default null
   */
@@ -239,12 +239,12 @@ Ember.Application = Ember.Namespace.extend(
           }
         });
 
+    @property customEvents
     @type Object
     @default null
   */
   customEvents: null,
 
-  /** @private */
   init: function() {
     if (!this.$) { this.$ = Ember.$; }
 
@@ -306,6 +306,9 @@ Ember.Application = Ember.Namespace.extend(
         router.get('commentsController')  // <App.CommentsController:ember1235>
 
         router.get('postsController.router') // router
+
+    @method initialize
+    @param router {Ember.Router}
   */
   initialize: function(router) {
     var injections = get(this.constructor, 'injections'),
@@ -350,7 +353,6 @@ Ember.Application = Ember.Namespace.extend(
     return this;
   },
 
-  /** @private */
   didBecomeReady: function() {
     var eventDispatcher = get(this, 'eventDispatcher'),
         customEvents    = get(this, 'customEvents'),
@@ -372,6 +374,9 @@ Ember.Application = Ember.Namespace.extend(
 
     If the application has a router, use it to route to the current URL, and
     trigger a new call to `route` whenever the URL changes.
+
+    @method startRouting
+    @property router {Ember.Router}
   */
   startRouting: function(router) {
     var location = get(router, 'location'),
@@ -396,10 +401,11 @@ Ember.Application = Ember.Namespace.extend(
   /**
     Called when the Application has become ready.
     The call will be delayed until the DOM has become ready.
+
+    @event ready
   */
   ready: Ember.K,
 
-  /** @private */
   willDestroy: function() {
     get(this, 'eventDispatcher').destroy();
     if (this._createdRouter)          { this._createdRouter.destroy(); }