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

Merge branch 'devel' of https://github.com/triAGENS/ArangoDB into devel

This commit is contained in:
scottashton 2014-07-11 13:30:08 +02:00
parent ba2d7a7745 ac4398ab7e
commit bc8d68c0fd
4 changed files with 53 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Documentation/Scripts/generateSwagger.py Normal file → Executable file
View File

@ -105,6 +105,30 @@ def BackTicks(txt, wordboundary = ['<em>','</em>']):
return r.sub(subpattern, txt)
################################################################################
### @brief AsteriskItalic
###
### *word* -> <b>word</b>
################################################################################
def AsteriskItalic(txt, wordboundary = ['<em>','</em>']):
r = rc(r"""([\(\s'/">]|^|.)\*(.*?)\*([<\s\.\),:;'"?!/-]|$)""", MS)
subpattern = '\\1' + wordboundary[0] + '\\2' + wordboundary[1] + '\\3'
return r.sub(subpattern, txt)
################################################################################
### @brief AsteriskBold
###
### **word** -> <b>word</b>
################################################################################
def AsteriskBold(txt, wordboundary = ['<em>','</em>']):
r = rc(r"""([\(\s'/">]|^|.)\*\*(.*?)\*\*([<\s\.\),:;'"?!/-]|$)""", MS)
subpattern = '\\1' + wordboundary[0] + '\\2' + wordboundary[1] + '\\3'
return r.sub(subpattern, txt)
################################################################################
### @brief FA
###
@ -152,6 +176,8 @@ def Typography(txt):
txt = txt[0:-1]
txt = BackTicks(txt)
txt = AsteriskItalic(txt)
txt = AsteriskBold(txt)
txt = FN(txt)
txt = LIT(txt)
txt = FA(txt)

2
Documentation/Scripts/generateSwaggerApi.py Normal file → Executable file
View File

@ -64,7 +64,7 @@ files = {
"js/actions/api-system.js" : "system",
"js/actions/api-transaction.js" : "transaction",
"js/actions/api-traversal.js" : "traversal",
"Documentation/ImplementorManual/HttpUser.md" : "user",
"js/actions/api-user.js" : "user",
"lib/Admin/RestVersionHandler.cpp" : "version"
}

6
js/actions/api-user.js
View File

@ -41,6 +41,8 @@ var users = require("org/arangodb/users");
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @COMMENT{######################################################################}
/// @anchor HttpUserDocument
/// @startDocuBlock JSF_api_user_fetch
///
/// @RESTHEADER{GET /_api/user/{user}, Fetch User}
@ -99,6 +101,8 @@ function get_api_user (req, res) {
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @COMMENT{######################################################################}
/// @anchor HttpUserSave
/// @startDocuBlock JSF_api_user_create
///
/// @RESTHEADER{POST /_api/user, Create User}
@ -284,6 +288,8 @@ function put_api_user (req, res) {
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @COMMENT{######################################################################}
/// @anchor HttpUserUpdate
/// @startDocuBlock JSF_api_user_update
///
/// @RESTHEADER{PATCH /_api/user/{user}, Update User}

30
js/common/modules/org/arangodb/arango-collection-common.js
View File

@ -614,22 +614,32 @@ ArangoCollection.prototype.closedRange = function (name, left, right) {
///
/// arango> db.complex.ensureGeoIndex(""home"");
/// arango> db.complex.near(0, 170).limit(5).toArray();
/// [ { "_id" : "complex/74655276", "_key" : "74655276", "_rev" : "74655276", "name" : "Name/0/170", "home" : [ 0, 170 ], "work" : [ 0, -170 ] },
/// { "_id" : "complex/74720812", "_key" : "74720812", "_rev" : "74720812", "name" : "Name/0/180", "home" : [ 0, 180 ], "work" : [ 0, -180 ] },
/// { "_id" : "complex/77080108", "_key" : "77080108", "_rev" : "77080108", "name" : "Name/10/170", "home" : [ 10, 170 ], "work" : [ -10, -170 ] },
/// { "_id" : "complex/72230444", "_key" : "72230444", "_rev" : "72230444", "name" : "Name/-10/170", "home" : [ -10, 170 ], "work" : [ 10, -170 ] },
/// { "_id" : "complex/72361516", "_key" : "72361516", "_rev" : "72361516", "name" : "Name/0/-180", "home" : [ 0, -180 ], "work" : [ 0, 180 ] } ]
/// [ { "_id" : "complex/74655276", "_key" : "74655276", "_rev" : "74655276", "name" :
/// "Name/0/170", "home" : [ 0, 170 ], "work" : [ 0, -170 ] },
/// { "_id" : "complex/74720812", "_key" : "74720812", "_rev" : "74720812", "name" :
/// "Name/0/180", "home" : [ 0, 180 ], "work" : [ 0, -180 ] },
/// { "_id" : "complex/77080108", "_key" : "77080108", "_rev" : "77080108", "name" :
/// "Name/10/170", "home" : [ 10, 170 ], "work" : [ -10, -170 ] },
/// { "_id" : "complex/72230444", "_key" : "72230444", "_rev" : "72230444", "name" :
/// "Name/-10/170", "home" : [ -10, 170 ], "work" : [ 10, -170 ] },
/// { "_id" : "complex/72361516", "_key" : "72361516", "_rev" : "72361516", "name" :
/// "Name/0/-180", "home" : [ 0, -180 ], "work" : [ 0, 180 ] } ]
///
/// arango> db.complex.geo("work").near(0, 170).limit(5);
/// exception in file '/simple-query' at 1018,5: a geo-index must be known
///
/// arango> db.complex.ensureGeoIndex("work");
/// arango> db.complex.geo("work").near(0, 170).limit(5).toArray();
/// [ { "_id" : "complex/72427052", "_key" : "72427052", "_rev" : "72427052", "name" : "Name/0/-170", "home" : [ 0, -170 ], "work" : [ 0, 170 ] },
/// { "_id" : "complex/72361516", "_key" : "72361516", "_rev" : "72361516", "name" : "Name/0/-180", "home" : [ 0, -180 ], "work" : [ 0, 180 ] },
/// { "_id" : "complex/70002220", "_key" : "70002220", "_rev" : "70002220", "name" : "Name/-10/-170", "home" : [ -10, -170 ], "work" : [ 10, 170 ] },
/// { "_id" : "complex/74851884", "_key" : "74851884", "_rev" : "74851884", "name" : "Name/10/-170", "home" : [ 10, -170 ], "work" : [ -10, 170 ] },
/// { "_id" : "complex/74720812", "_key" : "74720812", "_rev" : "74720812", "name" : "Name/0/180", "home" : [ 0, 180 ], "work" : [ 0, -180 ] } ]
/// [ { "_id" : "complex/72427052", "_key" : "72427052", "_rev" : "72427052", "name" :
/// "Name/0/-170", "home" : [ 0, -170 ], "work" : [ 0, 170 ] },
/// { "_id" : "complex/72361516", "_key" : "72361516", "_rev" : "72361516", "name" :
/// "Name/0/-180", "home" : [ 0, -180 ], "work" : [ 0, 180 ] },
/// { "_id" : "complex/70002220", "_key" : "70002220", "_rev" : "70002220", "name" :
/// "Name/-10/-170", "home" : [ -10, -170 ], "work" : [ 10, 170 ] },
/// { "_id" : "complex/74851884", "_key" : "74851884", "_rev" : "74851884", "name" :
/// "Name/10/-170", "home" : [ 10, -170 ], "work" : [ -10, 170 ] },
/// { "_id" : "complex/74720812", "_key" : "74720812", "_rev" : "74720812", "name" :
/// "Name/0/180", "home" : [ 0, 180 ], "work" : [ 0, -180 ] } ]
/// ```
///
/// @endDocuBlock