From cdb2e6e565f1019e0092b522674c9daa05c87b37 Mon Sep 17 00:00:00 2001 From: Sascha Matzke Date: Fri, 6 Mar 2009 22:56:02 +0100 Subject: [PATCH] added doc skeletons --- bson/reader/reader-docs.factor | 17 ++ bson/writer/writer-docs.factor | 23 ++ mongodb/driver/driver-docs.factor | 306 ++++++++++++++++++++++ mongodb/operations/operations-docs.factor | 23 ++ 4 files changed, 369 insertions(+) create mode 100644 bson/reader/reader-docs.factor create mode 100644 bson/writer/writer-docs.factor create mode 100644 mongodb/driver/driver-docs.factor create mode 100644 mongodb/operations/operations-docs.factor diff --git a/bson/reader/reader-docs.factor b/bson/reader/reader-docs.factor new file mode 100644 index 0000000000..be300f4be6 --- /dev/null +++ b/bson/reader/reader-docs.factor @@ -0,0 +1,17 @@ +! Copyright (C) 2009 Your name. +! See http://factorcode.org/license.txt for BSD license. +USING: assocs help.markup help.syntax kernel ; +IN: bson.reader + +HELP: stream>assoc +{ $values + { "exemplar" null } + { "assoc" assoc } { "bytes-read" null } +} +{ $description "" } ; + +ARTICLE: "bson.reader" "bson.reader" +{ $vocab-link "bson.reader" } +; + +ABOUT: "bson.reader" diff --git a/bson/writer/writer-docs.factor b/bson/writer/writer-docs.factor new file mode 100644 index 0000000000..cbcf1d2659 --- /dev/null +++ b/bson/writer/writer-docs.factor @@ -0,0 +1,23 @@ +! Copyright (C) 2009 Your name. +! See http://factorcode.org/license.txt for BSD license. +USING: assocs help.markup help.syntax kernel ; +IN: bson.writer + +HELP: assoc>array +{ $values + { "assoc" assoc } + { "byte-array" null } +} +{ $description "" } ; + +HELP: assoc>stream +{ $values + { "assoc" assoc } +} +{ $description "" } ; + +ARTICLE: "bson.writer" "bson.writer" +{ $vocab-link "bson.writer" } +; + +ABOUT: "bson.writer" diff --git a/mongodb/driver/driver-docs.factor b/mongodb/driver/driver-docs.factor new file mode 100644 index 0000000000..d06bbe4ed4 --- /dev/null +++ b/mongodb/driver/driver-docs.factor @@ -0,0 +1,306 @@ +! Copyright (C) 2009 Your name. +! See http://factorcode.org/license.txt for BSD license. +USING: assocs help.markup help.syntax kernel quotations ; +IN: mongodb.driver + +HELP: +{ $values + { "name" null } + { "collection" null } +} +{ $description "" } ; + +HELP: +{ $values + { "id" null } { "collection" null } { "return#" null } + { "cursor" null } +} +{ $description "" } ; + +HELP: +{ $values + { "db" null } { "host" null } { "port" null } + { "mdb" null } +} +{ $description "" } ; + +HELP: +{ $values + { "collection" "the collection to be queried" } { "query" "query" } + { "mdb-query" "mdb-query-msg tuple instance" } +} +{ $description "create a new query instance" } ; + +HELP: DIRTY? +{ $values + + { "value" null } +} +{ $description "" } ; + +HELP: MDB-GENERAL-ERROR +{ $values + + { "value" null } +} +{ $description "" } ; + +HELP: PARTIAL? +{ $values + + { "value" null } +} +{ $description "" } ; + +HELP: asc +{ $values + { "key" null } + { "spec" null } +} +{ $description "" } ; + +HELP: boolean +{ $values + + { "value" null } +} +{ $description "" } ; + +HELP: count +{ $values + { "collection" null } { "query" null } + { "result" null } +} +{ $description "" } ; + +HELP: create-collection +{ $values + { "name" null } +} +{ $description "" } ; + +HELP: delete +{ $values + { "collection" null } { "selector" null } +} +{ $description "" } ; + +HELP: delete-unsafe +{ $values + { "collection" null } { "selector" null } +} +{ $description "" } ; + +HELP: desc +{ $values + { "key" null } + { "spec" null } +} +{ $description "" } ; + +HELP: drop-collection +{ $values + { "name" null } +} +{ $description "" } ; + +HELP: drop-index +{ $values + { "collection" null } { "name" null } +} +{ $description "" } ; + +HELP: ensure-collection +{ $values + { "collection" null } + { "fq-collection" null } +} +{ $description "" } ; + +HELP: ensure-index +{ $values + { "collection" null } { "name" null } { "spec" null } +} +{ $description "" } ; + +HELP: explain +{ $values + { "mdb-query" null } + { "result" null } +} +{ $description "" } ; + +HELP: find +{ $values + { "mdb-query" null } + { "cursor" null } { "result" null } +} +{ $description "" } ; + +HELP: find-one +{ $values + { "mdb-query" null } + { "result" null } +} +{ $description "" } ; + +HELP: get-more +{ $values + { "mdb-cursor" null } + { "mdb-cursor" null } { "objects" null } +} +{ $description "" } ; + +HELP: hint +{ $values + { "mdb-query" null } { "index-hint" null } + { "mdb-query" null } +} +{ $description "" } ; + +HELP: lasterror +{ $values + + { "error" null } +} +{ $description "" } ; + +HELP: limit +{ $values + { "mdb-query" null } { "limit#" null } + { "mdb-query" null } +} +{ $description "" } ; + +HELP: load-collection-list +{ $values + + { "collection-list" null } +} +{ $description "" } ; + +HELP: load-index-list +{ $values + + { "index-list" null } +} +{ $description "" } ; + +HELP: master>> +{ $values + { "mdb" null } + { "inet" null } +} +{ $description "" } ; + +HELP: mdb +{ $values + + { "mdb" null } +} +{ $description "" } ; + +HELP: mdb-collection +{ $values + + { "value" null } +} +{ $description "" } ; + +HELP: mdb-cursor +{ $values + + { "value" null } +} +{ $description "" } ; + +HELP: mdb-db +{ $values + + { "value" null } +} +{ $description "" } ; + +HELP: mdb-error +{ $values + { "id" null } { "msg" null } +} +{ $description "" } ; + +HELP: mdb-instance +{ $values + + { "value" null } +} +{ $description "" } ; + +HELP: mdb-node +{ $values + + { "value" null } +} +{ $description "" } ; + +HELP: save +{ $values + { "collection" null } { "assoc" assoc } +} +{ $description "" } ; + +HELP: save-unsafe +{ $values + { "collection" null } { "object" object } +} +{ $description "" } ; + +HELP: skip +{ $values + { "mdb-query" null } { "skip#" null } + { "mdb-query" null } +} +{ $description "" } ; + +HELP: slave>> +{ $values + { "mdb" null } + { "inet" null } +} +{ $description "" } ; + +HELP: sort +{ $values + { "mdb-query" null } { "quot" quotation } + { "mdb-query" null } +} +{ $description "" } ; + +HELP: update +{ $values + { "collection" null } { "selector" null } { "object" object } +} +{ $description "" } ; + +HELP: update-unsafe +{ $values + { "collection" null } { "selector" null } { "object" object } +} +{ $description "" } ; + +HELP: validate +{ $values + { "collection" null } +} +{ $description "" } ; + +HELP: with-db +{ $values + { "mdb" null } { "quot" quotation } + { "..." null } +} +{ $description "" } ; + +ARTICLE: "mongodb.driver" "mongodb.driver" +{ $vocab-link "mongodb.driver" } +; + +ABOUT: "mongodb.driver" diff --git a/mongodb/operations/operations-docs.factor b/mongodb/operations/operations-docs.factor new file mode 100644 index 0000000000..c6d00db1e8 --- /dev/null +++ b/mongodb/operations/operations-docs.factor @@ -0,0 +1,23 @@ +! Copyright (C) 2009 Your name. +! See http://factorcode.org/license.txt for BSD license. +USING: help.markup help.syntax kernel ; +IN: mongodb.operations + +HELP: read-message +{ $values + + { "message" null } +} +{ $description "" } ; + +HELP: write-message +{ $values + { "message" null } +} +{ $description "" } ; + +ARTICLE: "mongodb.operations" "mongodb.operations" +{ $vocab-link "mongodb.operations" } +; + +ABOUT: "mongodb.operations"