1
0
Fork 0
arangodb/RestServer/module-actions.dox

78 lines
2.6 KiB
Plaintext

////////////////////////////////////////////////////////////////////////////////
/// @brief module "actions"
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2012 triAGENS GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
/// http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Dr. Frank Celler
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page JSModuleActionsTOC
///
/// <ol>
/// <li>@ref JSModuleActionsDefineHttp "defineHttp"</li>
/// <li>@ref JSModuleActionsActionResult "actionResult"</li>
/// <li>@ref JSModuleActionsActionResultOK "actionResultOK"</li>
/// <li>@ref JSModuleActionsActionResultError "actionResultError"</li>
/// <li>@ref JSModuleActionsActionResultUnsupported "actionResultUnsupported"</li>
/// <li>@ref JSModuleActionsActionError "actionError"</li>
/// </ol>
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @page JSModuleActions Module "actions"
///
/// The action module provides the infrastructure for defining HTTP actions.
///
/// <hr>
/// @copydoc JSModuleActionsTOC
/// <hr>
///
/// @anchor JSModuleActionsDefineHttp
/// @copydetails JSF_defineHttp
/// <hr>
///
/// @anchor JSModuleActionsActionResult
/// @copydetails JSF_actionResult
/// <hr>
///
/// @anchor JSModuleActionsActionResultOK
/// @copydetails JSF_actionResultOK
/// <hr>
///
/// @anchor JSModuleActionsActionResultError
/// @copydetails JSF_actionResultError
/// <hr>
///
/// @anchor JSModuleActionsActionResultUnsupported
/// @copydetails JSF_actionResultUnsupported
/// <hr>
///
/// @anchor JSModuleActionsActionError
/// @copydetails JSF_actionError
////////////////////////////////////////////////////////////////////////////////
// Local Variables:
// mode: outline-minor
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
// End: