mirror of https://gitee.com/bigwinds/arangodb
103 lines
3.5 KiB
Plaintext
103 lines
3.5 KiB
Plaintext
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief arango shell
|
|
///
|
|
/// @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
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- HANDLING EDGES
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page ShellEdgeTOC
|
|
///
|
|
/// <ul>
|
|
/// <li>@ref ShellEdge
|
|
/// <ul>
|
|
/// <li>@ref ShellEdgeIntro</li>
|
|
/// <li>@ref ShellEdgeShell
|
|
/// @copydetails ShellEdgeCallsTOC
|
|
/// </li>
|
|
/// </ul>
|
|
/// </li>
|
|
/// </ul>
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page ShellEdgeCallsTOC
|
|
///
|
|
/// <ul>
|
|
/// <li>@ref ShellEdgeCreate "edge-collection.save"</li>
|
|
/// <li>@ref ShellEdgeEdges "edge-collection.edges"</li>
|
|
/// <li>@ref ShellEdgeInEdges "edge-collection.inEdges"</li>
|
|
/// <li>@ref ShellEdgeOutEdges "edge-collection.outEdges"</li>
|
|
/// </ul>
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @page ShellEdge Handling Edges
|
|
///
|
|
/// This is an introduction to ArangoDB's interface for edges and how handle
|
|
/// edges from the JavaScript shell @LIT{arangosh}. For other languages see the
|
|
/// corresponding language API.
|
|
///
|
|
/// @EMBEDTOC{ShellEdgeTOC}
|
|
///
|
|
/// @section ShellEdgeIntro Edges, Identifiers, Handles
|
|
///////////////////////////////////////////////////////
|
|
///
|
|
/// @copydoc GlossaryEdge
|
|
///
|
|
/// @copydoc GlossaryEdgeCollection
|
|
///
|
|
/// @CLEARPAGE
|
|
/// @section ShellEdgeShell Working with Edges
|
|
//////////////////////////////////////////////
|
|
///
|
|
/// @anchor ShellEdgeCreate
|
|
/// @copydetails JS_SaveEdgesCol
|
|
///
|
|
/// @CLEARPAGE
|
|
/// @anchor ShellEdgeEdges
|
|
/// @copydetails JS_EdgesQuery
|
|
///
|
|
/// @CLEARPAGE
|
|
/// @anchor ShellEdgeInEdges
|
|
/// @copydetails JS_InEdgesQuery
|
|
///
|
|
/// @CLEARPAGE
|
|
/// @anchor ShellEdgeOutEdges
|
|
/// @copydetails JS_OutEdgesQuery
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- END-OF-FILE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// Local Variables:
|
|
// mode: c++
|
|
// mode: outline-minor
|
|
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @page\\|/// @\\}\\)"
|
|
// End:
|