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

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

This commit is contained in:
Frank Celler 2013-03-27 15:34:21 +01:00
parent 3ea5fbe121 17e46826f6
commit fe8ab5fa8c
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/UserManual/Foxx.md
View File

@ -92,22 +92,22 @@ If you define a route like described above, you have the option to match parts o
Furthermore you can describe your API by chaining the following methods onto your path definition. With the provided information, Foxx will generate a nice documentation for you. Some of the methods additionally will check certain properties of the request.
#### Describing a pathParam
/// @fn JSF_foxx_RequestContext_pathParam
@copydetails JSF_foxx_RequestContext_pathParam
#### Describing a queryParam
/// @fn JSF_foxx_RequestContext_queryParam
@copydetails JSF_foxx_RequestContext_queryParam
### Documenting the nickname of a route
/// @fn JSF_foxx_RequestContext_nickname
@copydetails JSF_foxx_RequestContext_nickname
### Documenting the summary of a route
/// @fn JSF_foxx_RequestContext_summary
@copydetails JSF_foxx_RequestContext_summary
### Documenting the notes of a route
/// @fn JSF_foxx_RequestContext_notes
@copydetails JSF_foxx_RequestContext_notes
### Documenting the error response of a route
/// @fn JSF_foxx_RequestContext_errorResponse
@copydetails JSF_foxx_RequestContext_errorResponse
### Before and After Hooks

4
js/server/modules/org/arangodb/foxx.js
View File

@ -431,7 +431,7 @@ _.extend(RequestContext.prototype, {
///
/// You can also provide a description of this parameter.
///
/// @EXAMPLE:
/// @EXAMPLES
/// app.get("/foxx/:id", function {
/// // Do something
/// }).pathParam("id", {
@ -472,7 +472,7 @@ _.extend(RequestContext.prototype, {
/// You can also provide a description of this parameter, if it is required and
/// if you can provide the parameter multiple times.
///
/// @EXAMPLE:
/// @EXAMPLES
/// app.get("/foxx", function {
/// // Do something
/// }).queryParam("id", {