Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fixed minor mistakes in general graph module documentation

This commit is contained in:
Michael Hackstein 2014-06-23 11:01:04 +02:00
parent 7bf98a463b
commit b37881c4de
1 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
js/common/modules/org/arangodb/general-graph.js
View File

@ -190,11 +190,11 @@ var wrapCollection = function(col) {
/// *Examples* are used to filter the result set for objects that match the conditions.
/// These *examples* can have the following values:
///
/// * Empty, there is no matching executed all found results are valid.
/// * A string, only the result having this value as it's *_id* is returned.
/// * An example object, defining a set of attributes.
/// * *Null*, there is no matching executed all found results are valid.
/// * A *string*, only the result having this value as it's *_id* is returned.
/// * An example *object*, defining a set of attributes.
/// Only results having these attributes are matched.
/// * A list containing example objects and/or strings.
/// * A *list* containing example *objects* and/or *strings*.
/// All results matching at least one of the elements in the list are returned.
///
/// @endDocuBlock
@ -683,7 +683,7 @@ AQLGenerator.prototype.vertices = function(example) {
///
/// *Examples*
///
/// To request unfiltered starting vertices:
/// To request unfiltered source vertices:
///
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphFluentAQLFromVerticesUnfiltered}
/// var examples = require("org/arangodb/graph-examples/example-graph.js");
@ -692,7 +692,7 @@ AQLGenerator.prototype.vertices = function(example) {
/// query.fromVertices().toArray();
/// @END_EXAMPLE_ARANGOSH_OUTPUT
///
/// To request filtered starting vertices by a single example:
/// To request filtered source vertices by a single example:
///
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphFluentAQLFromVerticesFilteredSingle}
/// var examples = require("org/arangodb/graph-examples/example-graph.js");
@ -701,7 +701,7 @@ AQLGenerator.prototype.vertices = function(example) {
/// query.fromVertices({name: "Alice"}).toArray();
/// @END_EXAMPLE_ARANGOSH_OUTPUT
///
/// To request filtered starting vertices by multiple examples:
/// To request filtered source vertices by multiple examples:
///
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphFluentAQLFromVerticesFilteredMultiple}
/// var examples = require("org/arangodb/graph-examples/example-graph.js");
@ -746,7 +746,7 @@ AQLGenerator.prototype.fromVertices = function(example) {
///
/// *Examples*
///
/// To request unfiltered starting vertices:
/// To request unfiltered target vertices:
///
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphFluentAQLToVerticesUnfiltered}
/// var examples = require("org/arangodb/graph-examples/example-graph.js");
@ -755,22 +755,22 @@ AQLGenerator.prototype.fromVertices = function(example) {
/// query.toVertices().toArray();
/// @END_EXAMPLE_ARANGOSH_OUTPUT
///
/// To request filtered starting vertices by a single example:
/// To request filtered target vertices by a single example:
///
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphFluentAQLToVerticesFilteredSingle}
/// var examples = require("org/arangodb/graph-examples/example-graph.js");
/// var g = examples.loadGraph("social");
/// var query = g._edges({type: "married"});
/// query.toVertices({name: "Alice"}).toArray();
/// query.toVertices({name: "Bob"}).toArray();
/// @END_EXAMPLE_ARANGOSH_OUTPUT
///
/// To request filtered starting vertices by multiple examples:
/// To request filtered target vertices by multiple examples:
///
/// @EXAMPLE_ARANGOSH_OUTPUT{generalGraphFluentAQLToVerticesFilteredMultiple}
/// var examples = require("org/arangodb/graph-examples/example-graph.js");
/// var g = examples.loadGraph("social");
/// var query = g._edges({type: "married"});
/// query.toVertices([{name: "Alice"}, {name: "Charly"}]).toArray();
/// query.toVertices([{name: "Bob"}, {name: "Diana"}]).toArray();
/// @END_EXAMPLE_ARANGOSH_OUTPUT
/// @endDocuBlock
///
@ -979,6 +979,8 @@ AQLGenerator.prototype._getLastRestrictableStatementInfo = function() {
/// Restriction is only applied to this one part of the query.
/// It does not effect earlier or later statements.
///
/// *Parameter*
///
/// * *restrictions*: Define either one or a list of collections in the graph.
/// Only elements from these collections are taken into account for the result.
///
@ -1228,7 +1230,9 @@ AQLGenerator.prototype.count = function() {
/// var examples = require("org/arangodb/graph-examples/example-graph.js");
/// var g = examples.loadGraph("social");
/// var query = g._vertices();
/// while (query.hasNext()) {query.next();}
/// | while (query.hasNext()) {
/// | query.next();
/// }
/// @END_EXAMPLE_ARANGOSH_OUTPUT
/// @endDocuBlock
///
@ -2731,7 +2735,7 @@ Graph.prototype._commonNeighbors = function(vertex1Example, vertex2Example, opti
/// `graph._countCommonNeighbors(vertex1Example, vertex2Examples, optionsVertex1, optionsVertex2)`
/// *Get the amount of common neighbors of the vertices defined by the examples.*
///
/// Similar to (_commonNeighbors)[#_commonNeighbors] but returns count instead of the elements.
/// Similar to [_commonNeighbors](#_commonNeighbors) but returns count instead of the elements.
///
/// *Examples*
///