From 3b7e8478e782407c5e26465386bfc6fccd1dc5d9 Mon Sep 17 00:00:00 2001 From: Alexis Abril Date: Wed, 30 Jul 2014 16:18:53 -0500 Subject: [PATCH] adding doc fixes for #1179 --- control/route/demo.html | 242 ++++++++++++------------ control/route/route.md | 2 +- map/attributes/doc/static.attributes.md | 4 +- map/delegate/doc/prototype.delegate.md | 40 ++-- map/doc/prototype.default-attr.md | 33 ++-- 5 files changed, 161 insertions(+), 160 deletions(-) diff --git a/control/route/demo.html b/control/route/demo.html index 4fff1121786..6bc1b182995 100644 --- a/control/route/demo.html +++ b/control/route/demo.html @@ -1,132 +1,132 @@ - - + + can.route demo - + - -

"eventHandler" : function(data)

-

- : - - function - (data) { -
-     data - // -> - -
} -

- -

Hash

-
- -

Links

- - -

can.route

-
- - - - + + + }; + + var Router = can.Control({ + " route" : function(data){ + setStatus("route", data); + }, + + ":type route" : function(data) { + setStatus(":type route", data); + }, + + "todo/:id route" : function(data) { + setStatus("todo/:id route", data); + } + }); + + new Router(window); + + can.route.ready(); + + new Observer($("
").appendTo("#route"), {
+				observe : can.route,
+				fullName : "can.route.attr("
+			});
+
+			setInput();
+			$(window).bind("hashchange", setInput);
+			$('#hash').change(function() {
+				window.location.hash = $(this).val();
+			});
+		})
+	
 
 
\ No newline at end of file
diff --git a/control/route/route.md b/control/route/route.md
index d794c90dce9..c2357eca86d 100644
--- a/control/route/route.md
+++ b/control/route/route.md
@@ -40,4 +40,4 @@ The following demo shows the above control in action.
 You can edit the hash, follow some example links or directly change the can.route attributes.
 At the top it shows the control action being called and the data passed to it:
 
-@iframe can/control/route/demo.html 700
+@demo can/control/route/demo.html
diff --git a/map/attributes/doc/static.attributes.md b/map/attributes/doc/static.attributes.md
index b958975d5cb..2e1e68fb7b9 100644
--- a/map/attributes/doc/static.attributes.md
+++ b/map/attributes/doc/static.attributes.md
@@ -4,7 +4,7 @@
 `can.Map.attributes` is a property that contains key/value pair(s) of an attribute's name and its
 respective type for using in [can.Map.attributes.static.convert convert] and [can.Map.prototype.serialize serialize].
 
-@codestart
+```
 var Contact = can.Map.extend({
     attributes : {
         birthday : 'date',
@@ -12,4 +12,4 @@ var Contact = can.Map.extend({
         name: 'string'
     }
 });
-@codeend
\ No newline at end of file
+```
diff --git a/map/delegate/doc/prototype.delegate.md b/map/delegate/doc/prototype.delegate.md
index b62cc639863..38aab9ec235 100644
--- a/map/delegate/doc/prototype.delegate.md
+++ b/map/delegate/doc/prototype.delegate.md
@@ -7,7 +7,7 @@
 in a child attribute from the parent. The child attribute
 does not have to exist.
 
-@codestart
+```
 // create an observable
 var o = new can.Map({
     foo : {
@@ -23,7 +23,7 @@ o.delegate('foo.bar', 'change', function(ev, prop, how, newVal, oldVal) {
 
 // change the property
 o.attr('foo.bar', 'Goodbye Cruel World');
-@codeend
+```
 
 ## Types of events
 
@@ -33,7 +33,7 @@ __add__
 
 An add event is fired when a new property has been added.
 
-@codestart
+```
 var o = new can.Control({});
 
 o.delegate('name', 'add', function(ev, value) {
@@ -43,7 +43,7 @@ o.delegate('name', 'add', function(ev, value) {
 
 o.attr('name', 'Justin')
 o.attr('name', 'Brian');
-@codeend
+```
 
 Listening to add events is useful for 'setup' functionality (in this case
 showing the #name element.
@@ -53,7 +53,7 @@ __set__
 Set events are fired when a property takes on a new value.  set events are
 always fired after an add.
 
-@codestart
+```
 o.delegate('name', 'set', function(ev, value) {
     // called twice
     can.$('#name').text(value)
@@ -61,13 +61,13 @@ o.delegate('name', 'set', function(ev, value) {
 
 o.attr('name', 'Justin')
 o.attr('name', 'Brian');
-@codeend
+```
 
 __remove__
 
 Remove events are fired after a property is removed.
 
-@codestart
+```
 o.delegate('name', 'remove', function(ev) {
     // called once
     $('#name').text(value)
@@ -75,7 +75,7 @@ o.delegate('name', 'remove', function(ev) {
 
 o.attr('name', 'Justin');
 o.removeAttr('name');
-@codeend
+```
 
 ## Wildcards - matching multiple properties
 
@@ -84,7 +84,7 @@ of an observe has changed. Delegate lets you use wildcards to
 match any property name.  The following listens for any change
 on an attribute of the params attribute:
 
-@codestart
+```
 var o = can.Control({
     options : {
         limit : 100,
@@ -108,7 +108,7 @@ o.attr('options.offset', 100);
 
 // alerts 2
 o.attr('options.params.parentId', 6);
-@codeend
+```
 
 Using a single wildcard (*) matches single level
 properties.  Using a double wildcard (**) matches
@@ -119,7 +119,7 @@ any deep property.
 Delegate lets you listen on multiple values at once.  The following listens
 for first and last name changes:
 
-@codestart
+```
 var o = new can.Map({
     name : { 
       first: 'Justin', 
@@ -132,13 +132,13 @@ o.bind('name.first, name.last',
     function(ev, newVal, oldVal, from) {
 
 });
-@codeend
+```
 
 ## Listening when properties are a particular value
 
 Delegate lets you listen when a property is __set__ to a specific value:
 
-@codestart
+```
 var o = new can.Map({
     name : 'Justin'
 });
@@ -148,19 +148,19 @@ o.bind('name=Brian',
     function(ev, newVal, oldVal, from) {
 
 });
-@codeend
+```
 
 @param {String} selector The attributes you want to listen for changes in.
 
 Selector should be the property or
 property names of the element you are searching.  Examples:
 
- "name" - listens to the "name" property changing
- "name, address" - listens to "name" or "address" changing
- "name address" - listens to "name" or "address" changing
- "address.*" - listens to property directly in address
- "address.**" - listens to any property change in address
- "foo=bar" - listens when foo is "bar"
+- "name" - listens to the "name" property changing
+- "name, address" - listens to "name" or "address" changing
+- "name address" - listens to "name" or "address" changing
+- "address.*" - listens to property directly in address
+- "address.**" - listens to any property change in address
+- "foo=bar" - listens when foo is "bar"
 
 @param {String} event The event name.  One of ("set","add","remove","change")
 @param {Function} handler(ev,newVal,oldVal,prop) The callback handler
diff --git a/map/doc/prototype.default-attr.md b/map/doc/prototype.default-attr.md
index 92dbf83f01c..a8c27a2bf40 100644
--- a/map/doc/prototype.default-attr.md
+++ b/map/doc/prototype.default-attr.md
@@ -13,20 +13,21 @@ be set as the `DEFAULT-ATTR` attribute's value.
 When extending [can.Map], if a prototype property is not a function,
 it is used as a default value on instances of the extended Map.  For example:
 
+```
+var Paginate = can.Map.extend({
+    limit: 20,
+    offset: 0,
+    next: function(){
+        this.attr("offset", this.attr("offset")+this.attr("limit"))
+    }
+});
 
-    var Paginate = can.Map.extend({
-        limit: 20,
-        offset: 0,
-        next: function(){
-            this.attr("offset", this.attr("offset")+this.attr("limit"))
-        }
-    });
-    
-    var paginate = new Paginate({limit: 30});
-
-    paginate.attr("offset") //-> 0
-    paginate.attr("limit")  //-> 30
-    
-    paginate.next();
-    
-    paginate.attr("offset") //-> 30
+var paginate = new Paginate({limit: 30});
+
+paginate.attr("offset") //-> 0
+paginate.attr("limit")  //-> 30
+
+paginate.next();
+
+paginate.attr("offset") //-> 30
+```