Show
Ignore:
Timestamp:
12/09/07 00:42:04 (13 months ago)
Author:
cho45
Message:

lang/javascript/jsdeferred/trunk/Rakefile,
lang/javascript/jsdeferred/trunk/makedoc.rb,
lang/javascript/jsdeferred/trunk/doc/index.html,
lang/javascript/jsdeferred/trunk/jsdeferred.js:

ドキュメントの修正

Location:
lang/javascript/jsdeferred/trunk
Files:
4 modified

Legend:

Unmodified
Added
Removed
  • lang/javascript/jsdeferred/trunk/Rakefile

    r2872 r2907  
    7575end 
    7676 
     77desc "Create Documentation" 
     78task :doc => ["doc/index.html"] do |t| 
     79end 
     80 
    7781task :update do 
    7882        sh %{svn up} 
     
    104108end 
    105109 
    106 file "doc/index.html" => ["jsdeferred.js"] do |t| 
     110file "doc/index.html" => ["jsdeferred.js", "makedoc.rb"] do |t| 
    107111        sh %{ruby makedoc.rb} 
    108112end 
  • lang/javascript/jsdeferred/trunk/doc/index.html

    r2691 r2907  
    3535                        } 
    3636 
     37                        .funname, 
     38                        .paren { 
     39                                font-weight: bold; 
     40                        } 
     41 
     42                        .args { 
     43                                font-weight: normal; 
     44                        } 
     45 
    3746                        #footer { 
    3847                                margin: 2em 0; 
     
    4958                        <div class="section" id="0"> 
    5059                                 
     60                                 
    5161                                <h2>Header::</h2> 
    5262                                 
     
    5464                                <p>JSDeferred 
    5565Copyright (c) 2007 cho45 ( www.lowreal.net )</p> 
     66<p>http://coderepos.org/share/wiki/JSDeferred</p> 
    5667<p>Version:: 0.1.0 
    5768License:: MIT</p> 
     
    7788                        <div class="section" id="1"> 
    7889                                 
     90                                 
    7991                                <h2>Usage (with jQuery)::</h2> 
    8092                                 
     
    104116                        <div class="section" id="Deferred"> 
    105117                                 
    106                                 <h2><code>function Deferred () //=&gt; constructor</code></h2> 
     118                                 
     119                                <h2> 
     120                                        <span class="funname"> 
     121                                                Deferred 
     122                                        </span> 
     123                                        <span class="paren">(</span> 
     124                                        <span class="args"></span> 
     125                                        <span class="paren">)</span> 
     126                                        //=> 
     127                                        constructor 
     128                                </h2> 
    107129                                 
    108130                                <div class="body"> 
     
    119141                        <div class="section" id="Deferred.prototype.next"> 
    120142                                 
    121                                 <h2><code>function Deferred.prototype.next   (fun) //=&gt; Deferred</code></h2> 
     143                                 
     144                                <h2> 
     145                                        <span class="funname"> 
     146                                                Deferred.prototype.next 
     147                                        </span> 
     148                                        <span class="paren">(</span> 
     149                                        <span class="args">fun</span> 
     150                                        <span class="paren">)</span> 
     151                                        //=> 
     152                                        Deferred 
     153                                </h2> 
    122154                                 
    123155                                <div class="body"> 
     
    129161                        <div class="section" id="Deferred.prototype.error"> 
    130162                                 
    131                                 <h2><code>function Deferred.prototype.error  (fun) //=&gt; Deferred</code></h2> 
     163                                 
     164                                <h2> 
     165                                        <span class="funname"> 
     166                                                Deferred.prototype.error 
     167                                        </span> 
     168                                        <span class="paren">(</span> 
     169                                        <span class="args">fun</span> 
     170                                        <span class="paren">)</span> 
     171                                        //=> 
     172                                        Deferred 
     173                                </h2> 
    132174                                 
    133175                                <div class="body"> 
     
    141183                        <div class="section" id="Deferred.prototype.call"> 
    142184                                 
    143                                 <h2><code>function Deferred.prototype.call   (val) //=&gt; this</code></h2> 
     185                                 
     186                                <h2> 
     187                                        <span class="funname"> 
     188                                                Deferred.prototype.call 
     189                                        </span> 
     190                                        <span class="paren">(</span> 
     191                                        <span class="args">val</span> 
     192                                        <span class="paren">)</span> 
     193                                        //=> 
     194                                        this 
     195                                </h2> 
    144196                                 
    145197                                <div class="body"> 
     
    151203                        <div class="section" id="Deferred.prototype.fail"> 
    152204                                 
    153                                 <h2><code>function Deferred.prototype.fail   (err) //=&gt; this</code></h2> 
     205                                 
     206                                <h2> 
     207                                        <span class="funname"> 
     208                                                Deferred.prototype.fail 
     209                                        </span> 
     210                                        <span class="paren">(</span> 
     211                                        <span class="args">err</span> 
     212                                        <span class="paren">)</span> 
     213                                        //=> 
     214                                        this 
     215                                </h2> 
    154216                                 
    155217                                <div class="body"> 
     
    161223                        <div class="section" id="Deferred.prototype.cancel"> 
    162224                                 
    163                                 <h2><code>function Deferred.prototype.cancel (err) //=&gt; this</code></h2> 
     225                                 
     226                                <h2> 
     227                                        <span class="funname"> 
     228                                                Deferred.prototype.cancel 
     229                                        </span> 
     230                                        <span class="paren">(</span> 
     231                                        <span class="args">err</span> 
     232                                        <span class="paren">)</span> 
     233                                        //=> 
     234                                        this 
     235                                </h2> 
    164236                                 
    165237                                <div class="body"> 
     
    171243                        <div class="section" id="parallel"> 
    172244                                 
    173                                 <h2><code>function parallel (deferredlist) //=&gt; Deferred</code></h2> 
     245                                 
     246                                <h2> 
     247                                        <span class="funname"> 
     248                                                parallel 
     249                                        </span> 
     250                                        <span class="paren">(</span> 
     251                                        <span class="args">deferredlist</span> 
     252                                        <span class="paren">)</span> 
     253                                        //=> 
     254                                        Deferred 
     255                                </h2> 
    174256                                 
    175257                                <div class="body"> 
     
    200282                        <div class="section" id="wait"> 
    201283                                 
    202                                 <h2><code>function wait (sec) //=&gt; Deferred</code></h2> 
     284                                 
     285                                <h2> 
     286                                        <span class="funname"> 
     287                                                wait 
     288                                        </span> 
     289                                        <span class="paren">(</span> 
     290                                        <span class="args">sec</span> 
     291                                        <span class="paren">)</span> 
     292                                        //=> 
     293                                        Deferred 
     294                                </h2> 
    203295                                 
    204296                                <div class="body"> 
     
    216308                        <div class="section" id="next"> 
    217309                                 
    218                                 <h2><code>function next (fun) //=&gt; Deferred</code></h2> 
     310                                 
     311                                <h2> 
     312                                        <span class="funname"> 
     313                                                next 
     314                                        </span> 
     315                                        <span class="paren">(</span> 
     316                                        <span class="args">fun</span> 
     317                                        <span class="paren">)</span> 
     318                                        //=> 
     319                                        Deferred 
     320                                </h2> 
    219321                                 
    220322                                <div class="body"> 
     
    227329                        <div class="section" id="call"> 
    228330                                 
    229                                 <h2><code>function call (fun[, args...]) //=&gt; Deferred</code></h2> 
     331                                 
     332                                <h2> 
     333                                        <span class="funname"> 
     334                                                call 
     335                                        </span> 
     336                                        <span class="paren">(</span> 
     337                                        <span class="args">fun [, args...]</span> 
     338                                        <span class="paren">)</span> 
     339                                        //=> 
     340                                        Deferred 
     341                                </h2> 
    230342                                 
    231343                                <div class="body"> 
     
    254366                        <div class="section" id="loop"> 
    255367                                 
    256                                 <h2><code>function loop (n, fun) //=&gt; Deferred</code></h2> 
     368                                 
     369                                <h2> 
     370                                        <span class="funname"> 
     371                                                loop 
     372                                        </span> 
     373                                        <span class="paren">(</span> 
     374                                        <span class="args">n, fun</span> 
     375                                        <span class="paren">)</span> 
     376                                        //=> 
     377                                        Deferred 
     378                                </h2> 
    257379                                 
    258380                                <div class="body"> 
     
    278400                        <div class="section" id="Deferred.register"> 
    279401                                 
    280                                 <h2><code>function Deferred.register (name, fun) //=&gt; void 0</code></h2> 
     402                                 
     403                                <h2> 
     404                                        <span class="funname"> 
     405                                                Deferred.register 
     406                                        </span> 
     407                                        <span class="paren">(</span> 
     408                                        <span class="args">name, fun</span> 
     409                                        <span class="paren">)</span> 
     410                                        //=> 
     411                                        void 0 
     412                                </h2> 
    281413                                 
    282414                                <div class="body"> 
     
    300432                        <div class="section" id="Deferred.wrap"> 
    301433                                 
    302                                 <h2><code>function Deferred.wrap (dfun) //=&gt; Function</code></h2> 
     434                                 
     435                                <h2> 
     436                                        <span class="funname"> 
     437                                                Deferred.wrap 
     438                                        </span> 
     439                                        <span class="paren">(</span> 
     440                                        <span class="args">dfun</span> 
     441                                        <span class="paren">)</span> 
     442                                        //=> 
     443                                        Function 
     444                                </h2> 
    303445                                 
    304446                                <div class="body"> 
  • lang/javascript/jsdeferred/trunk/jsdeferred.js

    r2889 r2907  
    22 * JSDeferred 
    33 * Copyright (c) 2007 cho45 ( www.lowreal.net ) 
     4 * 
     5 * http://coderepos.org/share/wiki/JSDeferred 
    46 * 
    57 * Version:: 0.1.0 
     
    203205}; 
    204206 
    205 /* function call (fun[, args...]) //=> Deferred 
     207/* function call (fun [, args...]) //=> Deferred 
    206208 * 
    207209 * `call` function is for calling function asynchronous. 
  • lang/javascript/jsdeferred/trunk/makedoc.rb

    r2651 r2907  
    2020                        body.gsub!(/^ \* ?/, "") 
    2121                        p header 
    22                         _, name, args, retv = *%r{^function\s+([^\s]+)\s+\((.*)\)\s+//=>\s+(.+)}.match(header) 
     22                        _, name, arg, retv = *%r{^function\s+([^\s]+)\s+\((.*)\)\s+//=>\s+(.+)}.match(header) 
    2323                        if _ 
    2424                                #p [name, args, retv] 
    25                                 _, req, opt = */([^\[\]]+)(?:\[, ([^\[\]]+)\])?/.match(args) 
     25                                _, req, opt = */([^\[\]]+)(?:\[, ([^\[\]]+)\])?/.match(arg) 
    2626                                args = [] 
    2727                                args.concat(req.split(/,\s*/)) if req 
    2828                                args.concat(opt.split(/,\s*/)) if opt 
    2929                                @functions[name] = { 
     30                                        :name => name, 
     31                                        :arg  => arg, 
    3032                                        :args => args, 
    3133                                        :retv => retv, 
     
    156158                        } 
    157159 
     160                        .funname, 
     161                        .paren { 
     162                                font-weight: bold; 
     163                        } 
     164 
     165                        .args { 
     166                                font-weight: normal; 
     167                        } 
     168 
    158169                        #footer { 
    159170                                margin: 2em 0; 
     
    169180                        <% doc.each_section do |section| %> 
    170181                        <div class="section" id="<%=h section.sid %>"> 
    171                                 <% if section.name %> 
    172                                 <h2><code><%=h section.header %></code></h2> 
     182                                <% fun = doc.functions[section.name] %> 
     183                                <% if fun %> 
     184                                <h2> 
     185                                        <span class="funname"> 
     186                                                <%=h fun[:name] %> 
     187                                        </span> 
     188                                        <span class="paren">(</span> 
     189                                        <span class="args"><%=h fun[:arg] %></span> 
     190                                        <span class="paren">)</span> 
     191                                        //=> 
     192                                        <%=h fun[:retv] %> 
     193                                </h2> 
    173194                                <% else %> 
    174195                                <h2><%=h section.header %></h2>