Skip to content

Commit

Permalink
Added more documentation fro gridstore class
Browse files Browse the repository at this point in the history
  • Loading branch information
christkv committed Jan 31, 2012
1 parent a00ea72 commit 319c87c
Show file tree
Hide file tree
Showing 6 changed files with 801 additions and 276 deletions.
1 change: 1 addition & 0 deletions HISTORY
Expand Up @@ -7,6 +7,7 @@
* Changed createCreateIndexCommand to work better with options.
* Fixed dereference method on Db class to correctly dereference Db reference objects.
* Moved connect object onto Db class(Db.connect) as well as keeping backward compatibility.
* Removed writeBuffer method from gridstore, write handles switching automatically now.

0.9.8-4 2012-01-28
* Added reIndex command to collection and db level.
Expand Down
8 changes: 5 additions & 3 deletions dev/tools/build-docs.js
Expand Up @@ -104,8 +104,9 @@ var apiClasses = [
// {tag:"objectid", path:"./lib/mongodb/bson/objectid.js"},
// {tag:"collection", path:"./lib/mongodb/collection.js"},
// {tag:"db", path:"./lib/mongodb/db.js"},
{tag:"cursor", path:"./lib/mongodb/cursor.js"},
{tag:"cursorstream", path:"./lib/mongodb/cursorstream.js"}
// {tag:"cursor", path:"./lib/mongodb/cursor.js"},
// {tag:"cursorstream", path:"./lib/mongodb/cursorstream.js"},
{tag:"gridstore", path:"./lib/mongodb/gridfs/gridstore.js"}
];

// All test files
Expand All @@ -124,7 +125,8 @@ var testClasses = [
{path:"./test/connect_test.js"},
{path:"./test/multiple_dbs_on_connection_pool_test.js"},
{path:"./test/cursor_test.js"},
{path:"./test/cursorstream_test.js"}
{path:"./test/cursorstream_test.js"},
{path:"./test/gridstore/grid_store_test.js"}
]

// Read all the templates
Expand Down
7 changes: 7 additions & 0 deletions dev/tools/doc-templates/class.ejs
Expand Up @@ -100,6 +100,13 @@ for(var i = 0; i < entries.length; i++) {
}
}
for(var i = 0; i < entries.length; i++) {
if(isProperty(entries[i])) {
%><%= format("\n------------------\nProperties\n------------------\n") %><%
break;
}
}
for(var i = 0; i < entries.length; i++) {
if(isProperty(entries[i])) {
// Extract values
Expand Down

0 comments on commit 319c87c

Please sign in to comment.