Merge pull request #45 from yanagiragi/master

Supports OSX and fix example test

Makefile

@@ -10,4 +10,8 @@ include vendor/github.com/reconquest/test-runner.bash/Makefile
 
 DST = /usr/local/bin/
 install:
-	cp shdoc $(DST)
+	case $$OSTYPE in \
+	darwin*) sed 's/\/usr\/bin\/gawk/\/usr\/bin\/env gawk/' shdoc > $(DST)/shdoc;; \
+	*) cp shdoc $(DST);; \
+	esac
+	chmod +x $(DST)shdoc

README.md

@@ -79,9 +79,9 @@ The project solves lots of problems:
 
 ## Index
 
-* [say-hello()](#say-hello)
+* [say-hello](#say-hello)
 
-### say-hello()
+### say-hello
 
 My super function.
 Not thread-safe.

shdoc

@@ -429,7 +429,7 @@ in_example {
     next
 }
 
-/^[ \t]*(function([ \t])+)?([a-zA-Z0-9_:-\\.]+)([ \t]*)(\(([ \t]*)\))?[ \t]*\{/ \
+/^[ \t]*(function([ \t])+)?([a-zA-Z0-9_\-:-\\.]+)([ \t]*)(\(([ \t]*)\))?[ \t]*\{/ \
     && (length(docblock) != 0 || description != "") && !in_example {
     debug("→ function")
     if (is_internal) {
@@ -440,8 +440,8 @@ in_example {
 
         is_internal = 0
         func_name = gensub(\
-            /^[ \t]*(function([ \t])+)?([a-zA-Z0-9_:-\\.]+)[ \t]*\(.*/, \
-            "\\3()", \
+            /^[ \t]*(function([ \t])+)?([a-zA-Z0-9_\-:-\\.]+)[ \t]*\(.*/, \
+            "\\3", \
             "g" \
         )
 

tests/testcases/@name-and-@description.test.sh

@@ -40,25 +40,25 @@ c
 
 ## Index
 
-* [a()](#a)
-* [b()](#b)
-* [c()](#c)
+* [a](#a)
+* [b](#b)
+* [c](#c)
 
-### a()
+### a
 
 func a
 line a 2
 
 _Function has no arguments._
 
-### b()
+### b
 
 func b
 ab
 
 _Function has no arguments._
 
-### c()
+### c
 
 func c
 

tests/testcases/@set.test.sh

@@ -24,9 +24,9 @@ a
 
 ## Index
 
-* [b()](#b)
+* [b](#b)
 
-### b()
+### b
 
 func b
 

tests/testcases/function-in-@example.test.sh

@@ -30,9 +30,9 @@ EOF
 tests:put expected <<EOF
 ## Index
 
-* [tests:value()](#testsvalue)
+* [tests:value](#testsvalue)
 
-### tests:value()
+### tests:value
 
 Same, as \`tests:eval\`, but writes stdout into given variable and
 return stderr as expected.

tests/testcases/function-tags.test.sh

@@ -29,9 +29,9 @@ EOF
 tests:put expected <<EOF
 ## Index
 
-* [some:first:func()](#somefirstfunc)
+* [some:first:func](#somefirstfunc)
 
-### some:first:func()
+### some:first:func
 
 Multiline description goes here and
 there

tests/testcases/issue-12-no-space-in-function-declaration.test.sh

@@ -17,14 +17,14 @@ EOF
 tests:put expected <<EOF
 ## Index
 
-* [fn1()](#fn1)
-* [fn2()](#fn2)
+* [fn1](#fn1)
+* [fn2](#fn2)
 
-### fn1()
+### fn1
 
 a desc for fn1
 
-### fn2()
+### fn2
 
 a desc for fn2
 EOF

tests/testcases/issue-25-missing-trailing-newline-in-see-also.test.sh

@@ -18,18 +18,18 @@ EOF
 tests:put expected <<EOF
 ## Index
 
-* [fn1()](#fn1)
-* [fn2()](#fn2)
+* [fn1](#fn1)
+* [fn2](#fn2)
 
-### fn1()
+### fn1
 
 a desc for fn1
 
 #### See also
 
 * [fn2()](#fn2)
 
-### fn2()
+### fn2
 
 a desc for fn2
 EOF

tests/testcases/issue-4-whitespace-in-function-declaration.test.sh

@@ -43,14 +43,14 @@ EOF
 tests:put expected <<EOF
 ## Index
 
-* [fn()](#fn)
-* [spaces()](#spaces)
-* [tab1()](#tab1)
-* [tab2()](#tab2)
-* [tab3()](#tab3)
-* [tab4()](#tab4)
+* [fn](#fn)
+* [spaces](#spaces)
+* [tab1](#tab1)
+* [tab2](#tab2)
+* [tab3](#tab3)
+* [tab4](#tab4)
 
-### fn()
+### fn
 
 #### Arguments
 
@@ -60,7 +60,7 @@ tests:put expected <<EOF
 
 * result of fn
 
-### spaces()
+### spaces
 
 #### Arguments
 
@@ -70,7 +70,7 @@ tests:put expected <<EOF
 
 * result of spaces
 
-### tab1()
+### tab1
 
 #### Arguments
 
@@ -80,7 +80,7 @@ tests:put expected <<EOF
 
 * result of tab1
 
-### tab2()
+### tab2
 
 #### Arguments
 
@@ -90,7 +90,7 @@ tests:put expected <<EOF
 
 * result of tab2
 
-### tab3()
+### tab3
 
 #### Arguments
 
@@ -100,7 +100,7 @@ tests:put expected <<EOF
 
 * result of tab3
 
-### tab4()
+### tab4
 
 #### Arguments
 

tests/testcases/table-of-contents.test.sh

@@ -19,16 +19,16 @@ EOF
 tests:put expected <<EOF
 ## Index
 
-* [some:first:func()](#somefirstfunc)
-* [some_other_func()](#some_other_func)
+* [some:first:func](#somefirstfunc)
+* [some_other_func](#some_other_func)
 
-### some:first:func()
+### some:first:func
 
 example function 1
 
 _Function has no arguments._
 
-### some_other_func()
+### some_other_func
 
 function with underscores