emberjs/ember.js — pull request #3082 by trek (2013-08-01 14:10:20+00:00)
Title: WIP documentation audit

We're doing an audit of the API documentation in preparation for a 1.0 release. The minimum goal is that any documentation is verified correct. A stretch goal is the ensure that every part of the public API has:

* premable blocks describing the major parts of the framework and their use (see `Em.Application`'s docs)
* each public method has a description and example use

Giant list outputted by `ls`:

- [ ] container/lib/main.js
- [ ] ember-application/lib/ext.js
- [ ] ember-application/lib/main.js
- [ ] ember-application/lib/system.js
- [ ] ember-debug/lib/main.js
- [ ] ember-handlebars-compiler/lib/main.js
- [ ] ember-handlebars/lib/controls.js
- [ ] ember-handlebars/lib/ext.js
- [ ] ember-handlebars/lib/helpers.js
- [ ] ember-handlebars/lib/loader.js
- [ ] ember-handlebars/lib/main.js
- [ ] ember-handlebars/lib/string.js
- [ ] ember-handlebars/lib/views.js
- [ ] ember-metal/lib/array.js
- [ ] ember-metal/lib/binding.js
- [ ] ember-metal/lib/chains.js
- [ ] ember-metal/lib/computed.js
- [ ] ember-metal/lib/core.js
- [ ] ember-metal/lib/enumerable_utils.js
- [ ] ember-metal/lib/events.js
- [ ] ember-metal/lib/instrumentation.js
- [ ] ember-metal/lib/main.js
- [ ] ember-metal/lib/map.js
- [ ] ember-metal/lib/mixin.js
- [ ] ember-metal/lib/observer.js
- [ ] ember-metal/lib/observer_set.js
- [ ] ember-metal/lib/platform.js
- [ ] ember-metal/lib/properties.js
- [ ] ember-metal/lib/property_events.js
- [ ] ember-metal/lib/property_get.js
- [ ] ember-metal/lib/property_set.js
- [ ] ember-metal/lib/run_loop.js
- [ ] ember-metal/lib/set_properties.js
- [ ] ember-metal/lib/utils.js
- [ ] ember-metal/lib/watch_key.js
- [ ] ember-metal/lib/watch_path.js
- [ ] ember-metal/lib/watching.js
- [ ] ember-old-router/lib/application.js
- [ ] ember-old-router/lib/controller_ext.js
- [ ] ember-old-router/lib/handlebars_ext.js
- [ ] ember-old-router/lib/helpers.js
- [ ] ember-old-router/lib/location.js
- [ ] ember-old-router/lib/main.js
- [ ] ember-old-router/lib/promise_chain.js
- [ ] ember-old-router/lib/resolved_state.js
- [ ] ember-old-router/lib/routable.js
- [ ] ember-old-router/lib/route.js
- [ ] ember-old-router/lib/route_matcher.js
- [ ] ember-old-router/lib/router.js
- [ ] ember-old-router/lib/view_ext.js
- [ ] ember-routing/lib/ext.js
- [ ] ember-routing/lib/helpers.js
- [ ] ember-routing/lib/location.js
- [ ] ember-routing/lib/main.js
- [ ] ember-routing/lib/system.js
- [ ] ember-runtime/lib/controllers.js
- [ ] ember-runtime/lib/core.js
- [ ] ember-runtime/lib/ext.js
- [ ] ember-runtime/lib/main.js
- [ ] ember-runtime/lib/mixins.js
- [ ] ember-runtime/lib/system.js
- [ ] ember-states/lib/main.js
- [ ] ember-states/lib/state.js
- [ ] ember-states/lib/state_manager.js
- [ ] ember-testing/lib/adapters.js
- [ ] ember-testing/lib/helpers.js
- [ ] ember-testing/lib/main.js
- [ ] ember-testing/lib/support.js
- [ ] ember-testing/lib/test.js
- [ ] ember-views/lib/core.js
- [ ] ember-views/lib/main.js
- [ ] ember-views/lib/mixins.js
- [ ] ember-views/lib/system.js
- [ ] ember-views/lib/views.js
- [ ] ember/lib/main.js
- [ ] loader/lib/main.js
- [ ] metamorph/lib/main.js
- [ ] rsvp/lib/main.js

ember-application/lib/ext:
- [ ] controller.js

ember-application/lib/system:
- [ ] application.js
- [ ] dag.js
- [ ] resolver.js

ember-handlebars/lib/controls:
- [ ] button.js
- [ ] checkbox.js
- [ ] select.js
- [ ] text_area.js
- [ ] text_field.js
- [ ] text_support.js

ember-handlebars/lib/helpers:
- [ ] binding.js
- [ ] collection.js
- [ ] debug.js
- [ ] each.js
- [ ] loc.js
- [ ] partial.js
- [ ] shared.js
- [ ] template.js
- [ ] unbound.js
- [ ] view.js
- [ ] yield.js

ember-handlebars/lib/views:
- [ ] handlebars_bound_view.js
- [ ] metamorph_view.js

ember-metal/lib/vendor:
- [ ] backburner.js

ember-old-router/lib/application:
- [ ] system
- [ ] system.js

ember-old-router/lib/helpers:
- [ ] action.js

ember-old-router/lib/location:
- [ ] api.js
- [ ] hash_location.js
- [ ] history_location.js
- [ ] none_location.js

ember-routing/lib/ext:
- [ ] controller.js
- [ ] view.js

ember-routing/lib/helpers:
- [ ] action.js
- [ ] control.js
- [ ] link_to.js
- [ ] outlet.js
- [ ] render.js
- [ ] shared.js

ember-routing/lib/location:
- [ ] api.js
- [ ] hash_location.js
- [ ] history_location.js
- [ ] none_location.js

ember-routing/lib/system:
- [ ] controller_for.js
- [ ] dsl.js
- [ ] route.js
- [ ] router.js

ember-routing/lib/vendor:
- [ ] route-recognizer.js
- [ ] router.js

ember-runtime/lib/controllers:
- [ ] array_controller.js
- [ ] controller.js
- [ ] object_controller.js

ember-runtime/lib/ext:
- [ ] ember.js
- [ ] function.js
- [ ] string.js

ember-runtime/lib/mixins:
- [ ] array.js
- [ ] comparable.js
- [ ] copyable.js
- [ ] deferred.js
- [ ] enumerable.js
- [ ] evented.js
- [ ] freezable.js
- [ ] mutable_array.js
- [ ] mutable_enumerable.js
- [ ] observable.js
- [ ] sortable.js
- [ ] target_action_support.js

ember-runtime/lib/system:
- [ ] application.js
- [ ] array_proxy.js
- [ ] container.js
- [ ] core_object.js
- [ ] deferred.js
- [ ] each_proxy.js
- [ ] lazy_load.js
- [ ] namespace.js
- [ ] native_array.js
- [ ] object.js
- [ ] object_proxy.js
- [ ] set.js
- [ ] string.js

ember-views/lib/mixins:
- [ ] view_target_action_support.js
ember-views/lib/system
- [ ] controller.js
- [ ] event_dispatcher.js
- [ ] ext.js
- [ ] jquery_ext.js
- [ ] render_buffer.js
- [ ] utils.js

ember-views/lib/views:
- [ ] collection_view.js
- [ ] component.js
- [ ] container_view.js
- [ ] states
- [ ] states.js
- [ ] view.js