Browse Source

Test documentation;

bjorn 10 years ago
parent
commit
94365778bf
2 changed files with 44 additions and 44 deletions
  1. 43 43
      doc/README.md
  2. 1 1
      tools/update_documentation.lua

+ 43 - 43
doc/README.md

@@ -1,51 +1,51 @@
 - [Observer](#Observer)
 - [Observer](#Observer)
-  - [create](#`.create(onNext,-onError,-onComplete)`)
-  - [onNext](#`:onNext(values)`)
-  - [onError](#`:onError(message)`)
-  - [onComplete](#`:onComplete()`)
+  - [create](#createonnext-onerror-oncomplete)
+  - [onNext](#onnextvalues)
+  - [onError](#onerrormessage)
+  - [onComplete](#oncomplete)
 - [Observable](#Observable)
 - [Observable](#Observable)
-  - [create](#`.create(subscribe)`)
-  - [fromValue](#`.fromValue(value)`)
-  - [fromRange](#`.fromRange(initial,-limit,-step)`)
-  - [fromTable](#`.fromTable(table,-iterator)`)
-  - [fromCoroutine](#`.fromCoroutine(coroutine)`)
-  - [subscribe](#`:subscribe(onNext,-onError,-onComplete)`)
-  - [dump](#`:dump(name)`)
-  - [combineLatest](#`:combineLatest(observables,-combinator)`)
-  - [concat](#`:concat(sources)`)
-  - [distinct](#`:distinct()`)
-  - [filter](#`:filter(predicate)`)
-  - [find](#`:find(predicate)`)
-  - [first](#`:first()`)
-  - [flatten](#`:flatten()`)
-  - [last](#`:last()`)
-  - [map](#`:map(callback)`)
-  - [max](#`:max()`)
-  - [min](#`:min()`)
-  - [merge](#`:merge(sources)`)
-  - [pack](#`:pack()`)
-  - [pluck](#`:pluck(key)`)
-  - [reduce](#`:reduce(accumulator,-seed)`)
-  - [skip](#`:skip(n)`)
-  - [skipUntil](#`:skipUntil(other)`)
-  - [sum](#`:sum()`)
-  - [take](#`:take(n)`)
-  - [takeUntil](#`:takeUntil(other)`)
-  - [unpack](#`:unpack()`)
-  - [unwrap](#`:unwrap()`)
+  - [create](#createsubscribe)
+  - [fromValue](#fromvaluevalue)
+  - [fromRange](#fromrangeinitial-limit-step)
+  - [fromTable](#fromtabletable-iterator)
+  - [fromCoroutine](#fromcoroutinecoroutine)
+  - [subscribe](#subscribeonnext-onerror-oncomplete)
+  - [dump](#dumpname)
+  - [combineLatest](#combinelatestobservables-combinator)
+  - [concat](#concatsources)
+  - [distinct](#distinct)
+  - [filter](#filterpredicate)
+  - [find](#findpredicate)
+  - [first](#first)
+  - [flatten](#flatten)
+  - [last](#last)
+  - [map](#mapcallback)
+  - [max](#max)
+  - [min](#min)
+  - [merge](#mergesources)
+  - [pack](#pack)
+  - [pluck](#pluckkey)
+  - [reduce](#reduceaccumulator-seed)
+  - [skip](#skipn)
+  - [skipUntil](#skipuntilother)
+  - [sum](#sum)
+  - [take](#taken)
+  - [takeUntil](#takeuntilother)
+  - [unpack](#unpack)
+  - [unwrap](#unwrap)
 - [Scheduler](#Scheduler)
 - [Scheduler](#Scheduler)
 - [CooperativeScheduler](#CooperativeScheduler)
 - [CooperativeScheduler](#CooperativeScheduler)
-  - [create](#`.create(currentTime)`)
-  - [schedule](#`:schedule(action,-delay)`)
-  - [update](#`:update(delta)`)
-  - [isEmpty](#`:isEmpty()`)
+  - [create](#createcurrenttime)
+  - [schedule](#scheduleaction-delay)
+  - [update](#updatedelta)
+  - [isEmpty](#isempty)
 - [Subject](#Subject)
 - [Subject](#Subject)
-  - [create](#`.create(value)`)
-  - [subscribe](#`:subscribe(onNext,-onError,-onComplete)`)
-  - [onNext](#`:onNext(values)`)
-  - [onError](#`:onError(message)`)
-  - [onComplete](#`:onComplete()`)
-  - [getValue](#`:getValue()`)
+  - [create](#createvalue)
+  - [subscribe](#subscribeonnext-onerror-oncomplete)
+  - [onNext](#onnextvalues)
+  - [onError](#onerrormessage)
+  - [onComplete](#oncomplete)
+  - [getValue](#getvalue)
 
 
 # Observer
 # Observer
 
 

+ 1 - 1
tools/update_documentation.lua

@@ -27,7 +27,7 @@ for _, comment in ipairs(comments) do
 
 
     local name = comment.context:match('function.-[:%.]([^%(]+)')
     local name = comment.context:match('function.-[:%.]([^%(]+)')
 
 
-    io.write('  - [' .. name .. '](#`' .. context:gsub(' ', '-') .. '`)\n')
+    io.write('  - [' .. name .. '](#' .. context:gsub('[^%w%s]+', ''):gsub(' ', '-'):lower() .. ')\n')
   end
   end
 end
 end