Skip to content
Newer
Older
100644 119 lines (115 sloc) 3.82 KB
4d70068 @fceller documentation and actions
fceller authored
1 ////////////////////////////////////////////////////////////////////////////////
2 /// @brief module "actions"
3 ///
4 /// @file
5 ///
6 /// DISCLAIMER
7 ///
8 /// Copyright 2012 triAGENS GmbH, Cologne, Germany
9 ///
10 /// Licensed under the Apache License, Version 2.0 (the "License");
11 /// you may not use this file except in compliance with the License.
12 /// You may obtain a copy of the License at
13 ///
14 /// http://www.apache.org/licenses/LICENSE-2.0
15 ///
16 /// Unless required by applicable law or agreed to in writing, software
17 /// distributed under the License is distributed on an "AS IS" BASIS,
18 /// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 /// See the License for the specific language governing permissions and
20 /// limitations under the License.
21 ///
22 /// Copyright holder is triAGENS GmbH, Cologne, Germany
23 ///
24 /// @author Dr. Frank Celler
25 /// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
26 ////////////////////////////////////////////////////////////////////////////////
27
28 ////////////////////////////////////////////////////////////////////////////////
29 /// @page JSModuleActionsTOC
30 ///
31 /// <ol>
7f2e3f1 @fceller doc
fceller authored
32 /// <li>@ref JSModuleActionsBasics
33 /// <ol>
34 /// <li>@ref JSModuleActionsDefineHttp "actions.defineHttp"</li>
35 /// <li>@ref JSModuleActionsResultError "actions.resultError"</li>
36 /// <li>@ref JSModuleActionsGetErrorMessage "actions.getErrorMessage"</li>
37 /// </ol>
38 /// </li>
39 /// <li>@ref JSModuleActionsHTTP
40 /// <ol>
41 /// <li>@ref JSModuleActionsResultOk "actions.resultOK"</li>
42 /// <li>@ref JSModuleActionsResultBad "actions.resultBad"</li>
43 /// <li>@ref JSModuleActionsResultNotFound "actions.resultNotFound"</li>
44 /// <li>@ref JSModuleActionsResultUnsupported "actions.resultUnsupported"</li>
45 /// </ol>
46 /// </li>
47 /// <li>@ref JSModuleActionsAvocadoDB
48 /// <ol>
49 /// <li>@ref JSModuleActionsCollectionNotFound "actions.collectionNotFound"</li>
50 /// <li>@ref JSModuleActionsIndexNotFound "actions.indexNotFound"</li>
51 /// <li>@ref JSModuleActionsResultException "actions.resultException"</li>
52 /// </ol>
53 /// </li>
4d70068 @fceller documentation and actions
fceller authored
54 /// </ol>
55 ////////////////////////////////////////////////////////////////////////////////
56
57 ////////////////////////////////////////////////////////////////////////////////
58 /// @page JSModuleActions Module "actions"
59 ///
60 /// The action module provides the infrastructure for defining HTTP actions.
61 ///
62 /// <hr>
63 /// @copydoc JSModuleActionsTOC
64 /// <hr>
65 ///
7f2e3f1 @fceller doc
fceller authored
66 /// @section JSModuleActionsBasics Basics
67 /////////////////////////////////////////
68 ///
4d70068 @fceller documentation and actions
fceller authored
69 /// @anchor JSModuleActionsDefineHttp
7f2e3f1 @fceller doc
fceller authored
70 /// @copydetails JSF_DefineHttp
71 /// <hr>
72 ///
73 /// @anchor JSModuleActionsResultError
74 /// @copydetails JSF_ResultError
75 /// <hr>
76 ///
77 /// @anchor JSModuleActionsGetErrorMessage
78 /// @copydetails JSF_GetErrorMessage
beaaf3b @fceller cleanup of documentation
fceller authored
79 /// <hr>
7f2e3f1 @fceller doc
fceller authored
80 ///
81 /// @section JSModuleActionsHTTP Standard HTTP Result Generators
82 ////////////////////////////////////////////////////////////////
83 ///
84 /// @anchor JSModuleActionsResultOk
85 /// @copydetails JSF_ResultOk
4d70068 @fceller documentation and actions
fceller authored
86 /// <hr>
87 ///
7f2e3f1 @fceller doc
fceller authored
88 /// @anchor JSModuleActionsResultBad
89 /// @copydetails JSF_ResultBad
4d70068 @fceller documentation and actions
fceller authored
90 /// <hr>
91 ///
7f2e3f1 @fceller doc
fceller authored
92 /// @anchor JSModuleActionsResultNotFound
93 /// @copydetails JSF_ResultNotFound
4d70068 @fceller documentation and actions
fceller authored
94 /// <hr>
95 ///
7f2e3f1 @fceller doc
fceller authored
96 /// @anchor JSModuleActionsResultUnsupported
97 /// @copydetails JSF_ResultUnsupported
98 /// <hr>
99 ///
100 /// @section JSModuleActionsAvocadoDB AvocadoDB Result Generators
101 /////////////////////////////////////////////////////////////////
102 ///
103 /// @anchor JSModuleActionsCollectionNotFound
104 /// @copydetails JSF_CollectionNotFound
4d70068 @fceller documentation and actions
fceller authored
105 /// <hr>
106 ///
7f2e3f1 @fceller doc
fceller authored
107 /// @anchor JSModuleActionsIndexNotFound
108 /// @copydetails JSF_IndexNotFound
4d70068 @fceller documentation and actions
fceller authored
109 /// <hr>
110 ///
7f2e3f1 @fceller doc
fceller authored
111 /// @anchor JSModuleActionsResultException
112 /// @copydetails JSF_ResultException
4d70068 @fceller documentation and actions
fceller authored
113 ////////////////////////////////////////////////////////////////////////////////
114
115 // Local Variables:
116 // mode: outline-minor
117 // outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
118 // End:
Something went wrong with that request. Please try again.