Permalink
Browse files

Codo: finished first-pass documentation. Renamed kb.DefaultWrapper to…

… kb.DefaultObservable (deprecated) and bumped version to 0.16.1
  • Loading branch information...
1 parent 07f7b06 commit 1ac267954b753161ea5f72a4ebe4bcfabd8f00eb Kevin Malakoff committed Sep 5, 2012
Showing with 2,929 additions and 840 deletions.
  1. +2 −2 Bakefile.coffee
  2. +6 −8 README.md
  3. +1 −1 doc/LICENSE.html
  4. +7 −10 doc/README.md.html
  5. +1 −1 doc/assets/search_data.js
  6. +2 −2 doc/class_index.html
  7. +1 −1 doc/class_list.html
  8. +92 −19 doc/classes/kb.html
  9. +50 −15 doc/classes/kb/CollectionObservable.html
  10. +252 −0 doc/classes/kb/DefaultObservable.html
  11. +48 −9 doc/classes/kb/DefaultWrapper.html
  12. +72 −6 doc/classes/kb/Factory.html
  13. +59 −7 doc/classes/kb/FormattedObservable.html
  14. +177 −12 doc/classes/kb/LocalizedObservable.html
  15. +180 −11 doc/classes/kb/ModelWatcher.html
  16. +202 −32 doc/classes/kb/Observable.html
  17. +65 −33 doc/classes/kb/Statistics.html
  18. +207 −77 doc/classes/kb/Store.html
  19. +96 −28 doc/classes/kb/TriggeredObservable.html
  20. +261 −14 doc/classes/kb/ViewModel.html
  21. +260 −64 doc/classes/kb/utils.html
  22. +27 −83 doc/method_list.html
  23. +15 −15 knockback-core-stack.js
  24. +2 −2 knockback-core-stack.min.js
  25. +14 −14 knockback-core.js
  26. +2 −2 knockback-core.min.js
  27. +28 −23 knockback-full-stack.js
  28. +2 −2 knockback-full-stack.min.js
  29. +27 −22 knockback.js
  30. +2 −2 knockback.min.js
  31. +12 −7 lib/knockback-defaults.js
  32. +1 −1 lib/knockback-defaults.min.js
  33. +1 −1 lib/knockback-localization.js
  34. +1 −1 lib/knockback-localization.min.js
  35. +1 −1 package.json
  36. +6 −8 packages/npm/README.md
  37. +15 −15 packages/npm/knockback-core-stack.js
  38. +2 −2 packages/npm/knockback-core-stack.min.js
  39. +15 −15 packages/npm/knockback-core.js
  40. +2 −2 packages/npm/knockback-core.min.js
  41. +28 −23 packages/npm/knockback-full-stack.js
  42. +2 −2 packages/npm/knockback-full-stack.min.js
  43. +28 −23 packages/npm/knockback.js
  44. +2 −2 packages/npm/knockback.min.js
  45. +12 −7 packages/npm/lib/knockback-defaults.js
  46. +1 −1 packages/npm/lib/knockback-defaults.min.js
  47. +1 −1 packages/npm/lib/knockback-localization.js
  48. +1 −1 packages/npm/lib/knockback-localization.min.js
  49. +1 −1 packages/npm/package.json
  50. +15 −15 packages/nuget/Content/Scripts/knockback-core-stack.js
  51. +2 −2 packages/nuget/Content/Scripts/knockback-core-stack.min.js
  52. +15 −15 packages/nuget/Content/Scripts/knockback-core.js
  53. +2 −2 packages/nuget/Content/Scripts/knockback-core.min.js
  54. +28 −23 packages/nuget/Content/Scripts/knockback-full-stack.js
  55. +2 −2 packages/nuget/Content/Scripts/knockback-full-stack.min.js
  56. +28 −23 packages/nuget/Content/Scripts/knockback.js
  57. +2 −2 packages/nuget/Content/Scripts/knockback.min.js
  58. +12 −7 packages/nuget/Content/Scripts/lib/knockback-defaults.js
  59. +1 −1 packages/nuget/Content/Scripts/lib/knockback-defaults.min.js
  60. +1 −1 packages/nuget/Content/Scripts/lib/knockback-localization.js
  61. +1 −1 packages/nuget/Content/Scripts/lib/knockback-localization.min.js
  62. +1 −1 packages/nuget/package.nuspec
  63. +17 −8 src/knockback-core/knockback-collection-observable.coffee
  64. +40 −8 src/knockback-core/knockback-core.coffee
  65. +19 −0 src/knockback-core/knockback-factory.coffee
  66. +27 −9 src/knockback-core/knockback-model-watcher.coffee
  67. +46 −9 src/knockback-core/knockback-observable.coffee
  68. +45 −1 src/knockback-core/knockback-store.coffee
  69. +84 −4 src/knockback-core/knockback-utils.coffee
  70. +75 −11 src/knockback-core/knockback-view-model.coffee
  71. +45 −0 src/knockback-defaults/knockback-default-observable.coffee
  72. +0 −32 src/knockback-defaults/knockback-default-wrapper.coffee
  73. +6 −0 src/knockback-defaults/knockback-extensions.coffee
  74. +13 −5 src/knockback-formatting/knockback-formatted-observable.coffee
  75. +56 −20 src/knockback-localization/knockback-localized-observable.coffee
  76. +13 −0 src/knockback-statistics/knockback-statistics.coffee
  77. +35 −2 src/knockback-triggering/knockback-triggered-observable.coffee
  78. +4 −4 test/knockback-defaults/test.coffee
  79. +2 −1 test/knockback-legacy/test.coffee
View
@@ -11,7 +11,7 @@ module.exports =
'src/knockback-core/knockback-observable.coffee'
'src/knockback-core/knockback-view-model.coffee'
'src/knockback-core/knockback-collection-observable.coffee'
- 'src/knockback-defaults/knockback-default-wrapper.coffee'
+ 'src/knockback-defaults/knockback-default-observable.coffee'
'src/knockback-formatting/knockback-formatted-observable.coffee'
'src/knockback-localization/knockback-localized-observable.coffee'
'src/knockback-triggering/knockback-triggered-observable.coffee'
@@ -37,7 +37,7 @@ module.exports =
compress: true
files: [
'src/component-imports.coffee'
- 'src/knockback-defaults/knockback-default-wrapper.coffee'
+ 'src/knockback-defaults/knockback-default-observable.coffee'
'src/knockback-defaults/knockback-extensions.coffee'
]
View
@@ -20,8 +20,6 @@ You can get the library here:
**NOTE: there are breaking changes in 0.16.+** Please see the [release notes](https://github.com/kmalakoff/knockback/wiki/Release-Notes) for details.
-Also, I am in the process of updating the release notes, website, and releasing a reference application for 0.16.0 so they are slightly out-of-sync with this release. I'll have this done by the end of the week.
-
### Dependencies
* [Backbone.js][4]
@@ -33,14 +31,14 @@ Also, I am in the process of updating the release notes, website, and releasing
* [BackboneRelational.js](https://github.com/PaulUithol/Backbone-relational/) - provides helpers for one-to-one and one-to-many relationships between your Backbone.Models.
* [BackboneModelRef.js](https://github.com/kmalakoff/backbone-modelref/) - provides a reference to a Backbone.Model that can be bound to your view before the model is loaded from the server (along with relevant load state notifications).
-* (***new***) [KnockbackNavigators.js](https://github.com/kmalakoff/knockback-navigators/) - provides page and pane navigation including history and state (useful for single-page and mobile apps). Can be used independently from Knockback.js.
+* (***new!***) [KnockbackNavigators.js](https://github.com/kmalakoff/knockback-navigators/) - provides page and pane navigation including history and state (useful for single-page and mobile apps). Can be used independently from Knockback.js.
* [KnockbackInspector.js](https://github.com/kmalakoff/knockback-inspector/) - provides customizable tree view of models and collections for viewing and editing your data (useful for debugging and visualizaing JSON).
###Demos and Documentation
For comprehensive tutorials, take a look at the website: http://kmalakoff.github.com/knockback/
-Please try the [TodoMVC App](http://kmalakoff.github.com/knockback-todos/) and check out the [Knockback.js Reference App](http://kmalakoff.github.com/knockback-reference-app/) for some best practices when using Knockback.js.
+Please try the [TodoMVC App](http://kmalakoff.github.com/knockback-todos/) and check out the (***new!***) [Knockback.js Reference App](http://kmalakoff.github.com/knockback-reference-app/) for some best practices when using Knockback.js.
Why Write Knockback.js?
@@ -79,7 +77,7 @@ or (Coffeescript)
class ContactViewModel extends kb.ViewModel
constructor: (model) ->
super(model, {internals: ['email', 'date']}) # call super constructor: @name, @_email, and @_date created in super from the model attributes
- @email = kb.defaultWrapper(@_email, 'your.name@yourplace.com')
+ @email = kb.defaultObservable(@_email, 'your.name@yourplace.com')
@date = new LongDateLocalizer(@_date)
```
@@ -89,7 +87,7 @@ or (Javascript)
var ContactViewModel = kb.ViewModel.extend({
constructor: function(model) {
kb.ViewModel.prototype.constructor.call(this, model, {internals: ['email', 'date']}); // call super constructor: @name, @_email, and @_date created in super from the model attributes
- this.email = kb.defaultWrapper(this._email, 'your.name@yourplace.com');
+ this.email = kb.defaultObservable(this._email, 'your.name@yourplace.com');
this.date = new LongDateLocalizer(this._date);
return this;
}
@@ -135,8 +133,8 @@ Building, Running and Testing the library
Look at: https://github.com/kmalakoff/easy-bake
[1]: http://kmalakoff.github.com/knockback/
-[2]: https://raw.github.com/kmalakoff/knockback/0.16.0/knockback.js
-[3]: https://raw.github.com/kmalakoff/knockback/0.16.0/knockback.min.js
+[2]: https://raw.github.com/kmalakoff/knockback/0.16.1/knockback.js
+[3]: https://raw.github.com/kmalakoff/knockback/0.16.1/knockback.min.js
[4]: http://backbonejs.org/
[5]: http://underscorejs.org/
[6]: http://knockoutjs.com/
View
@@ -138,7 +138,7 @@
</div>
<div id='footer'>
Generated on
- Wed Sep 05 2012 16:16:23 GMT+0900 (JST)
+ Wed Sep 05 2012 23:36:37 GMT+0900 (JST)
by
<a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
v1.3.0
View
@@ -134,15 +134,12 @@
</p>
<ul>
-<li><a href="https://raw.github.com/kmalakoff/knockback/0.16.0/knockback.js">Development version</a></li>
-<li><a href="https://raw.github.com/kmalakoff/knockback/0.16.0/knockback.min.js">Production version</a></li>
+<li><a href="https://raw.github.com/kmalakoff/knockback/0.16.1/knockback.js">Development version</a></li>
+<li><a href="https://raw.github.com/kmalakoff/knockback/0.16.1/knockback.min.js">Production version</a></li>
</ul>
<p><strong>NOTE: there are breaking changes in 0.16.+</strong> Please see the <a href="https://github.com/kmalakoff/knockback/wiki/Release-Notes">release notes</a> for details.
</p>
-<p>Also, I am in the process of updating the release notes, website, and releasing a reference application for 0.16.0 so they are slightly out-of-sync with this release. I&#39;ll have this done by the end of the week.
-
-</p>
<h3>Dependencies</h3>
<ul>
<li><a href="http://backbonejs.org/">Backbone.js</a></li>
@@ -153,14 +150,14 @@
<ul>
<li><a href="https://github.com/PaulUithol/Backbone-relational/">BackboneRelational.js</a> - provides helpers for one-to-one and one-to-many relationships between your Backbone.Models.</li>
<li><a href="https://github.com/kmalakoff/backbone-modelref/">BackboneModelRef.js</a> - provides a reference to a Backbone.Model that can be bound to your view before the model is loaded from the server (along with relevant load state notifications).</li>
-<li>(<strong><em>new</em></strong>) <a href="https://github.com/kmalakoff/knockback-navigators/">KnockbackNavigators.js</a> - provides page and pane navigation including history and state (useful for single-page and mobile apps). Can be used independently from Knockback.js.</li>
+<li>(<strong><em>new!</em></strong>) <a href="https://github.com/kmalakoff/knockback-navigators/">KnockbackNavigators.js</a> - provides page and pane navigation including history and state (useful for single-page and mobile apps). Can be used independently from Knockback.js.</li>
<li><a href="https://github.com/kmalakoff/knockback-inspector/">KnockbackInspector.js</a> - provides customizable tree view of models and collections for viewing and editing your data (useful for debugging and visualizaing JSON).</li>
</ul>
<h3>Demos and Documentation</h3>
<p>For comprehensive tutorials, take a look at the website: <a href="http://kmalakoff.github.com/knockback/">http://kmalakoff.github.com/knockback/</a>
</p>
-<p>Please try the <a href="http://kmalakoff.github.com/knockback-todos/">TodoMVC App</a> and check out the <a href="http://kmalakoff.github.com/knockback-reference-app/">Knockback.js Reference App</a> for some best practices when using Knockback.js.
+<p>Please try the <a href="http://kmalakoff.github.com/knockback-todos/">TodoMVC App</a> and check out the (<strong><em>new!</em></strong>) <a href="http://kmalakoff.github.com/knockback-reference-app/">Knockback.js Reference App</a> for some best practices when using Knockback.js.
</p>
@@ -198,15 +195,15 @@
<pre><code class="lang-coffeescript">class ContactViewModel extends kb.ViewModel
constructor: (model) -&gt;
super(model, {internals: [&#39;email&#39;, &#39;date&#39;]}) # call super constructor: @name, @_email, and @_date created in super from the model attributes
- @email = kb.defaultWrapper(@_email, &#39;your.name@yourplace.com&#39;)
+ @email = kb.defaultObservable(@_email, &#39;your.name@yourplace.com&#39;)
@date = new LongDateLocalizer(@_date)</code></pre>
<p>or (Javascript)
</p>
<pre><code class="lang-javascript">var ContactViewModel = kb.ViewModel.extend({
constructor: function(model) {
kb.ViewModel.prototype.constructor.call(this, model, {internals: [&#39;email&#39;, &#39;date&#39;]}); // call super constructor: @name, @_email, and @_date created in super from the model attributes
- this.email = kb.defaultWrapper(this._email, &#39;your.name@yourplace.com&#39;);
+ this.email = kb.defaultObservable(this._email, &#39;your.name@yourplace.com&#39;);
this.date = new LongDateLocalizer(this._date);
return this;
}
@@ -246,7 +243,7 @@
</div>
<div id='footer'>
Generated on
- Wed Sep 05 2012 16:16:23 GMT+0900 (JST)
+ Wed Sep 05 2012 23:36:37 GMT+0900 (JST)
by
<a href='https://github.com/netzpirat/codo' title='CoffeeScript API documentation generator'>Codo</a>
v1.3.0
Oops, something went wrong. Retry.

0 comments on commit 1ac2679

Please sign in to comment.