Commits

Nikhil Marathe committed 03a5fa4

Fixed some documentation

Comments (0)

Files changed (2)

 all: doc
 
 doc: redis.lsp
-	sh -c 'cd doc; newlispdoc -s ../redis.lsp'
+	sh -c 'cd doc; newlispdoc -s ../*.lsp'
 ;; @description newLISP bindings for the Redis database ( http://code.google.com/p/redis )
 ;; @version 0.1
 ;; @author Nikhil Marathe <nsm.nikhil@gmail.com> 2010
-;; @homepage @link http://bitbucket.org/nikhilm/newlisp-redis http://bitbucket.org/nikhilm/newlisp-redis
+;; @link http://bitbucket.org/nikhilm/newlisp-redis http://bitbucket.org/nikhilm/newlisp-redis
 ;;
 ;; This module provides bindings to Redis. It communicates
 ;; with the Redis server and returns values in appropriate
 ;; lisp-y types.
 ;;
+;; Commands are automatically generated, so the documentation
+;; can be found in the Redis Command Reference.
+;;
+;; For a reference look at @link ../test-redis.lsp test-redis.lsp
+;;
+;; To view a list of commands do:
+;; <pre> (println redis:inline-commands)</pre>
+;; and so on for other types
+;;
 ;; @example
 ;; (setf 'redis (redis:connect))
 ;; (redis:ping redis)
-;; => "+PONG"
+;; => "PONG"
 
 (context 'redis)
 
 
 (context MAIN)
 
-;; @syntax (redis <host> <port>)
+;; @syntax (redis [host] [port])
 ;; Creates a new connection to a Redis instance
 ;; @return a new connection object or nil on error
 (define (redis:redis (host "localhost") (port 6379))
       nil
       (list redis sock ""))))
 
+;; @syntax (:close redis)
+;; Closes a redis connection, including the socket
 (define (redis:close r)
   (:quit r)
   (net-close (r 1) true))