Merge pull request #6 from nats-io/doc

Add documentation of the public API
nats-io · Nov 12, 2015 · a46d0dd · a46d0dd
2 parents 2258463 + fcf355d
commit a46d0dd
Show file tree

Hide file tree

Showing 585 changed files with 72,732 additions and 227 deletions.
diff --git a/README.md b/README.md
@@ -128,6 +128,13 @@ for instance:
 NATS_TEST_SERVER_EXE=c:\test\gnatsd.exe
 ```
 
+## Documentation
+
+The public API has been documented using [Doxygen](http://www.stack.nl/~dimitri/doxygen/).
+
+To see the documentation, point your browser to the file `index.html` in the `doc/html` directory.
+
+The source code is also quite documented.
 
 ## Basic Usage
 

diff --git a/doc/DoxyFile.NATS.Client b/doc/DoxyFile.NATS.Client