1
0
Fork 0

Hook in stray docublocks from the foxx docuemtation

This commit is contained in:
Willi Goesgens 2015-08-13 16:12:43 +02:00
parent 2d00dcf82f
commit 0e4a345128
5 changed files with 22 additions and 0 deletions

View File

@ -86,6 +86,13 @@ API by chaining the following methods onto your path definition:
<!-- js/server/modules/org/arangodb/foxx/request_context.js -->
@startDocuBlock JSF_foxx_RequestContext_notes
!SUBSECTION pathParams in buffer
@startDocuBlock JSF_foxx_RequestContextBuffer_pathParam
!SUBSECTION bodyParams in buffer
@startDocuBlock JSF_foxx_RequestContextBuffer_queryParam
!SECTION Documenting and constraining all routes
In addition to documenting a specific route, you can also
@ -215,6 +222,9 @@ convenience methods:
<!-- js/server/modules/org/arangodb/foxx/base_middleware.js -->
@startDocuBlock JSF_foxx_BaseMiddleware_request_rawBodyBuffer
<!-- js/server/modules/org/arangodb/foxx/base_middleware.js -->
@startDocuBlock JSF_foxx_BaseMiddleware_request_requestParts
!SUBSECTION params
<!-- js/server/modules/org/arangodb/foxx/base_middleware.js -->
@startDocuBlock JSF_foxx_BaseMiddleware_request_params
@ -331,3 +341,6 @@ To use the application-specific authentication in your own app, first activate i
!SUBSUBSECTION Restricting routes
To restrict routes, see the documentation for Documenting and Restraining the routes.
@startDocuBlock JSF_foxx_controller_extend

View File

@ -200,6 +200,7 @@ FulltextRepository.prototype.indexes = [
@startDocuBlock JSF_foxx_repository_replaceByExample
!SUBSECTION Updating entries in the repository
@startDocuBlock JSF_foxx_repository_update
@startDocuBlock JSF_foxx_repository_updateById

View File

@ -3,6 +3,7 @@
Foxx provides some convenience methods to make working with sessions easier.
!SUBSECTION Activate sessions
@startDocuBlock JSF_foxx_controller_activateSessions
Enables session features for the controller.
@ -101,3 +102,5 @@ When using cookie sessions, this function will clear the session cookie (if *aut
* *method* (optional): HTTP method to handle. Default: `"post"`.
* *before* (optional): function to execute before the session is destroyed. Receives the same arguments as a regular route handler.
* *after* (optional): function to execute after the session is destroyed. Receives the same arguments as a regular route handler. Default: a function that sends a *{"message": "logged out"}* JSON response.
@startDocuBlock JSF_foxx_controller_destroySession

View File

@ -0,0 +1,3 @@
@startDocuBlock JSF_foxx_TemplateMiddleware_initializer
@startDocuBlock JSF_foxx_TemplateMiddleware_response_render

View File

@ -5,6 +5,7 @@
* [Windows](Installing/Windows.md)
* [Compiling](Installing/Compiling.md)
* [Upgrading](Installing/Upgrading.md)
* [Incompatible changes in 2.6](Upgrading/UpgradingChanges27.md)
* [Incompatible changes in 2.6](Upgrading/UpgradingChanges26.md)
* [Upgrading to 2.6](Upgrading/Upgrading26.md)
* [Incompatible changes in 2.5](Upgrading/UpgradingChanges25.md)
@ -111,6 +112,7 @@
* [Controller](Foxx/Develop/Controller.md)
* [Scripts](Foxx/Develop/Scripts.md)
* [Model](Foxx/Develop/Model.md)
* [View](Foxx/Develop/View.md)
* [Repository](Foxx/Develop/Repository.md)
* [Queries](Foxx/Develop/Queries.md)
* [Sessions](Foxx/Develop/Sessions.md)