misc. minor changes and documentation updates

readme/html/OxDoc.html

@@ -38,6 +38,64 @@
 </script>
 <h1>Ox.doc - A JavaScript Documentation Language</h1>
 
+<p>At its core, Ox.doc is list of lines like this:</p>
+<pre class="code">//@ name &lt;type&gt; summary</pre>
+<p>...</p>
+<pre class="code">/*@
+name &lt;type&gt; summary
+    Longer description
+    that may contain HTML.
+@*/
+</pre>
+
+<p>If you are documenting an object with properties, these lines can be nested:</p>
+<pre class="code">/*@
+My.team &lt;object&gt; Some sports team
+    name &lt;string&gt; The team's name
+    lastMatch &lt;object&gt; The most recent result
+        for &lt;number&gt; Goals for
+        against &lt;number&gt; Goals against
+    won &lt;boolean&gt; If true, last match was a win
+@*/</pre>
+
+<p>The same goes for functions and events:</p>
+<pre class="code">/*@
+My.readURL &lt;function&gt; Reads data from a remote URL
+    (url, callback) -&gt; &lt;o&gt; Request handler
+        cancel &lt;function&gt; The handler's only property. Takes no arguments. Cancels the request.
+    url &lt;string&gt; Remote URL
+    callback &lt;function&gt; Callback function
+        result &lt;object&gt; Result object
+            status &lt;number&gt; HTTP status code
+            data &lt;string&gt; Data read from URL, or empty string
+    stalled &lt;event&gt; Fires when the connection is stalled
+        reason &lt;string&gt; Potential cause of the network problem
+@*/</pre>
+
+
+<p></p>
+
+<pre class="code">/*@
+foo &lt;o&gt; Demo object
+    array     &lt;a&gt; An array (and we don't care about the type of its elements)
+    boolean   &lt;b&gt; True or false
+    date      &lt;d&gt; Date object
+    element   &lt;e&gt; DOM element
+    function  &lt;f&gt; A function
+    number    &lt;n&gt; A number
+    object    &lt;o&gt; An object
+    regexp    &lt;r&gt; Regular Expression
+    string    &lt;s&gt; A string
+    undefined &lt;u&gt; undefined
+        Makes most sense for the result of a function that doesn't return,
+        or as the last of multiple types, to indicate a property may be missing
+    any_value &lt;*&gt; anything
+    event     &lt;!&gt; A custom event
+    example1  &lt;[n]|u&gt; An array of numbers, or undefined
+    example2  &lt;s|'foo'&gt; A string, default 'foo'
+@*/
+</pre>
+
 <p>foo bar</p>
 
 <pre class="code" id="foo">//@ My.TYPES &lt;number&gt; Request timeout, in seconds
@@ -68,7 +126,7 @@ My.readURL &lt;f&gt; Reads data from a remote URL
         timeout &lt;n|60&gt; Timeout in seconds
         type &lt;s|'GET'&gt; Request type ('GET', 'POST', 'PUT' or 'DELETE')
     callback &lt;f&gt; Callback function
-        result &lt;o> Result object
+        result &lt;o&gt; Result object
             status &lt;n&gt; HTTP status code
             data &lt;s&gt; Data read from URL, or empty string
 @*/

source/Ox.UI/js/Calendar/Ox.Calendar.js

@@ -4,9 +4,9 @@
 
 /*@
 Ox.Calendar <f:Ox.Element> Basic calendar object
-    () ->              <f> Calendar object
+    () ->              <o> Calendar object
-    (options) ->       <f> Calendar object
+    (options) ->       <o> Calendar object
-    (options, self) -> <f> Calendar object
+    (options, self) -> <o> Calendar object
     options <o> Options object
         date    <d|new Date()> UTC Date on which the calendar is centered
         events  <[o]|[]> Event objects to be displayed

source/Ox.UI/js/Code/Ox.DocPage.js

@@ -149,7 +149,7 @@ Ox.DocPage = function(options, self) {
                                     });
                                 })
                         )
-                        .append('<b>' + Ox.toTitleCase(section) + '</b>')
+                        .append('<span class="OxSection">' + Ox.toTitleCase(section) + '</span>')
                     );
                     if (section == 'examples') {
                         item.examples.forEach(function(example) {

source/Ox.UI/js/List/Ox.TreeList.js

@@ -103,11 +103,6 @@ Ox.TreeList = function(options, self) {
                                 'symbol' + (data.expanded ? 'Down' : 'Right')
                             )
                         })
-                        .css({
-                            width: '10px',
-                            height: '10px',
-                            padding: '3px'
-                        })
                 )
                 .appendTo($item);
         }
@@ -251,9 +246,11 @@ Ox.TreeList = function(options, self) {
 
     self.setOption = function(key, value) {
         if (key == 'data') {
-            
+            // ...
+        } else if (key == 'selected') {
+            self.$list.options({selected: value});
         } else if (key == 'width') {
-            
+            // ...
         }
     };
 

source/Ox.UI/js/Panel/Ox.SplitPanel.js

@@ -1,10 +1,10 @@
 // vim: et:ts=4:sw=4:sts=4:ft=javascript
 'use strict';
 /*@
-Ox.SplitPanel <o:Ox.Element> SpliPanel Object
+Ox.SplitPanel <f:Ox.Element> SpliPanel Object
-    () ->              <f> SpliPanel Object
+    () ->              <o> SpliPanel Object
-    (options) ->       <f> SpliPanel Object
+    (options) ->       <o> SpliPanel Object
-    (options, self) -> <f> SpliPanel Object
+    (options, self) -> <o> SpliPanel Object
     options <o> Options object
         elements <[o]|[]> Array of two or three element objects
             collapsible <b|false> If true, can be collapsed (if outer element)
@@ -174,6 +174,18 @@ Ox.SplitPanel = function(options, self) {
         });
     }
 
+    /*@
+    getSize <f> get size of panel
+        (id) -> <i> id or position of panel, returns size
+        id <s|i> The element's id or position
+    @*/
+    // fixme: what is this? there is that.size()
+    that.getSize = function(id) {
+        var pos = Ox.isNumber(id) ? id : getPositionById(id),
+            element = self.options.elements[pos];
+		return element.element[self.dimensions[0]]() * !that.isCollapsed(pos);
+    };
+
     /*@
     isCollapsed <f> panel collapsed state
         (id) -> <b> id or position of panel, returns collapsed state
@@ -266,18 +278,6 @@ Ox.SplitPanel = function(options, self) {
 		}
     };
 
-    /*@
-    getSize <f> get size of panel
-        (id) -> <i> id or position of panel, returns size
-        id <s|i> The element's id or position
-    @*/
-    // fixme: what is this? there is that.size()
-    that.getSize = function(id) {
-        var pos = Ox.isNumber(id) ? id : getPositionById(id),
-            element = self.options.elements[pos];
-		return element.element[self.dimensions[0]]() * !that.isCollapsed(pos);
-    };
-
     /*@
     toggle <f> Toggles collapsed state of an outer element
         (id) -> <o> The SplitPanel

source/Ox.UI/js/Panel/Ox.TabPanel.js

@@ -1,5 +1,20 @@
 // vim: et:ts=4:sw=4:sts=4:ft=javascript
 
+/*@
+Ox.TabPanel <f> Tabbed panel
+    (options) -> <o> Panel
+    (options, self) -> <o> Panel
+    options <o> Options
+        content <o|f> Content per tab
+            Either <code>({id1: $element1, id2: $element2}}</code> or
+            <code>function(id) { return $element; })</code>
+        size <n|24> Height of the tab bar
+        tabs [o] Tabs
+            id <s> Tab id
+            title <s> Tab title
+    self <o> Shared private variable
+@*/
+
 'use strict';
 
 Ox.TabPanel = function(options, self) {

source/Ox/js/Collection.js

@@ -597,6 +597,8 @@ Ox.some <f> Tests if one or more elements of a collection satisfy a given condit
     true
     > Ox.some("foo", function(v) { return v == 'f'; })
     true
+    > Ox.some([false, 0, null, '', void 0])
+    false
 @*/
 Ox.some = function(obj, fn) {
     return Ox.filter(Ox.values(obj), fn || function(v) {

source/Ox/js/JavaScript.js

@@ -34,8 +34,8 @@ Ox.doc <f> Generates documentation for annotated JavaScript
             
     (source) <a> Array of documentation objects
     source <s> JavaScript source code
-    # > Ox.doc("//@ Ox.foo <string> just some string")
+    > Ox.doc("//@ My.FOO <n> Magic constant\nMy.FOO = 23;")
-    # [{"name": "Ox.foo", "summary": "just some string", "type": "string"}]
+    [{"name": "Ox.foo", "summary": "just some string", "type": "string"}]
 @*/
 
 Ox.doc = (function() {