Permalink
Browse files

edoc generation

  • Loading branch information...
1 parent 5cbf4de commit e94cec0ad354fcc35b59bcfc15f0045de9472ef1 Tony Hannan committed May 24, 2011
Showing with 11 additions and 9 deletions.
  1. +6 −2 README.md
  2. +1 −1 doc/clear_docs
  3. +2 −3 doc/gen_docs
  4. +0 −3 doc/gen_overview_doc
  5. +2 −0 doc/overview.edoc
View
@@ -71,7 +71,7 @@ See the [*mongo*](http://github.com/TonyGen/mongodb-erlang/blob/master/src/mongo
### Administering
-This driver does not provide helper functions for commands. Use `mongo:command` directly and refer to the [MongoDB documentation](http://www.mongodb.org/display/DOCS/Commands) for how to issue raw commands. A future version will probably include helper functions for the most common commands.
+This driver does not provide helper functions for commands. Use `mongo:command` directly and refer to the [MongoDB documentation](http://www.mongodb.org/display/DOCS/Commands) for how to issue raw commands. A future version may include helper functions for the most common commands.
### Pooling
@@ -91,4 +91,8 @@ To get a (replset-)connection from the pool
`Conn` can then be supplied to `mongo:do`. `resource_pool:get` will return `{error, Reason}` if can't connect.
-Close the pool when done using it and all its connection that were handed out via `resource_pool:close`. It will close all its connections, as well as itself.
+Close the pool when done using it and all its connections via `resource_pool:close`.
+
+### More Documentation
+
+[API Docs](http://api.mongodb.org/erlang/mongodb/) - Documentation generated from source code comments
View
@@ -1,2 +1,2 @@
#!/bin/sh
-rm *.html edoc-info erlang.png stylesheet.css overview.edoc
+rm *.html edoc-info erlang.png stylesheet.css
View
@@ -1,4 +1,3 @@
#!/bin/sh
-# Generate html docs from src code comment using edoc
-./gen_overview_doc
-erl -pa ../../bson/ebin/ ../../mongodb/ebin -eval 'edoc:application(mongodb, [{index_columns, 1}, {sort_functions, false}, {preprocess, true}]), init:stop()' -noshell
+# Generate html docs from src code comments using edoc
+erl -pa ../../bson/ebin/ ../../mongodb/ebin -eval 'edoc:application (mongodb, [{index_columns, 1}, {sort_functions, false}, {preprocess, true}]), init:stop()' -noshell
View
@@ -1,3 +0,0 @@
-#!/bin/sh
-# Generate overview.edoc from README.md using sed script from http://github.com/hdiedrich/markedoc
-sed -E -f ~/markedoc/bin/markedoc.sed ../README.md | sed s/\&/and/g | sed 's|http://github.com/TonyGen/bson-erlang|../bson/index.html|' | sed 's|http://github.com/TonyGen/mongodb-erlang/blob/master/src/mongo.erl|mongo.html|' > overview.edoc
View
@@ -0,0 +1,2 @@
+@doc
+See <a href="http://github.com/TonyGen/mongodb-erlang#readme">ReadMe</a> for overview.

0 comments on commit e94cec0

Please sign in to comment.