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

fixed doxygen errors

This commit is contained in:
Jan Steemann 2012-07-23 15:24:53 +02:00
parent ac0e4c1f59
commit c079eda53b
5 changed files with 66 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doxygen/arango-xml.doxy
View File

@ -1548,7 +1548,7 @@ HIDE_UNDOC_RELATIONS = YES
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)
HAVE_DOT = NO
HAVE_DOT = YES
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
# allowed to run in parallel. When set to 0 (the default) doxygen will

90
Makefile.in
View File

@ -376,28 +376,27 @@ am__lib_libarango_a_SOURCES_DIST = lib/Basics/ConditionLocker.cpp \
lib/Logger/LoggerStream.cpp lib/Logger/LoggerTiming.cpp \
lib/ProgramOptions/program-options.c \
lib/ProtocolBuffers/HttpRequestProtobuf.cpp \
lib/ProtocolBuffers/arangodb.pb.cpp lib/Rest/AddressPort.cpp \
lib/Rest/AnyServer.cpp lib/Rest/EndpointList.cpp \
lib/Rest/EndpointSpecification.cpp lib/Rest/Handler.cpp \
lib/Rest/HttpRequest.cpp lib/Rest/HttpRequestPlain.cpp \
lib/Rest/HttpResponse.cpp lib/Rest/Initialise.cpp \
lib/Rest/JsonContainer.cpp lib/Rest/SslInterface.cpp \
lib/Rest/Url.cpp lib/ShapedJson/json-shaper.c \
lib/ShapedJson/shape-accessor.c lib/ShapedJson/shaped-json.c \
lib/Statistics/statistics.cpp lib/Utilities/LineEditor.cpp \
lib/Utilities/ScriptLoader.cpp lib/Variant/VariantArray.cpp \
lib/Variant/VariantBlob.cpp lib/Variant/VariantBoolean.cpp \
lib/Variant/VariantDate.cpp lib/Variant/VariantDatetime.cpp \
lib/Variant/VariantDouble.cpp lib/Variant/VariantFloat.cpp \
lib/Variant/VariantInt16.cpp lib/Variant/VariantInt32.cpp \
lib/Variant/VariantInt64.cpp lib/Variant/VariantInt8.cpp \
lib/Variant/VariantMatrix2.cpp lib/Variant/VariantNull.cpp \
lib/Variant/VariantObject.cpp lib/Variant/VariantString.cpp \
lib/Variant/VariantUInt16.cpp lib/Variant/VariantUInt32.cpp \
lib/Variant/VariantUInt64.cpp lib/Variant/VariantUInt8.cpp \
lib/Variant/VariantVector.cpp lib/ZeroMQ/ApplicationZeroMQ.cpp \
lib/ZeroMQ/ZeroMQBatchJob.cpp lib/ZeroMQ/ZeroMQThread.cpp \
lib/ZeroMQ/ZeroMQQueueThread.cpp \
lib/ProtocolBuffers/arangodb.pb.cpp lib/Rest/AnyServer.cpp \
lib/Rest/EndpointList.cpp lib/Rest/EndpointSpecification.cpp \
lib/Rest/Handler.cpp lib/Rest/HttpRequest.cpp \
lib/Rest/HttpRequestPlain.cpp lib/Rest/HttpResponse.cpp \
lib/Rest/Initialise.cpp lib/Rest/JsonContainer.cpp \
lib/Rest/SslInterface.cpp lib/Rest/Url.cpp \
lib/ShapedJson/json-shaper.c lib/ShapedJson/shape-accessor.c \
lib/ShapedJson/shaped-json.c lib/Statistics/statistics.cpp \
lib/Utilities/LineEditor.cpp lib/Utilities/ScriptLoader.cpp \
lib/Variant/VariantArray.cpp lib/Variant/VariantBlob.cpp \
lib/Variant/VariantBoolean.cpp lib/Variant/VariantDate.cpp \
lib/Variant/VariantDatetime.cpp lib/Variant/VariantDouble.cpp \
lib/Variant/VariantFloat.cpp lib/Variant/VariantInt16.cpp \
lib/Variant/VariantInt32.cpp lib/Variant/VariantInt64.cpp \
lib/Variant/VariantInt8.cpp lib/Variant/VariantMatrix2.cpp \
lib/Variant/VariantNull.cpp lib/Variant/VariantObject.cpp \
lib/Variant/VariantString.cpp lib/Variant/VariantUInt16.cpp \
lib/Variant/VariantUInt32.cpp lib/Variant/VariantUInt64.cpp \
lib/Variant/VariantUInt8.cpp lib/Variant/VariantVector.cpp \
lib/ZeroMQ/ApplicationZeroMQ.cpp lib/ZeroMQ/ZeroMQBatchJob.cpp \
lib/ZeroMQ/ZeroMQThread.cpp lib/ZeroMQ/ZeroMQQueueThread.cpp \
lib/ZeroMQ/ZeroMQWorkerThread.cpp
am__dirstamp = $(am__leading_dot)dirstamp
@ENABLE_ZEROMQ_TRUE@am__objects_1 = \
@ -452,8 +451,7 @@ am_lib_libarango_a_OBJECTS = lib/Basics/ConditionLocker.$(OBJEXT) \
lib/ProgramOptions/program-options.$(OBJEXT) \
lib/ProtocolBuffers/HttpRequestProtobuf.$(OBJEXT) \
lib/ProtocolBuffers/arangodb.pb.$(OBJEXT) \
lib/Rest/AddressPort.$(OBJEXT) lib/Rest/AnyServer.$(OBJEXT) \
lib/Rest/EndpointList.$(OBJEXT) \
lib/Rest/AnyServer.$(OBJEXT) lib/Rest/EndpointList.$(OBJEXT) \
lib/Rest/EndpointSpecification.$(OBJEXT) \
lib/Rest/Handler.$(OBJEXT) lib/Rest/HttpRequest.$(OBJEXT) \
lib/Rest/HttpRequestPlain.$(OBJEXT) \
@ -1298,26 +1296,26 @@ lib_libarango_a_SOURCES = lib/Basics/ConditionLocker.cpp \
lib/Logger/LoggerStream.cpp lib/Logger/LoggerTiming.cpp \
lib/ProgramOptions/program-options.c \
lib/ProtocolBuffers/HttpRequestProtobuf.cpp \
lib/ProtocolBuffers/arangodb.pb.cpp lib/Rest/AddressPort.cpp \
lib/Rest/AnyServer.cpp lib/Rest/EndpointList.cpp \
lib/Rest/EndpointSpecification.cpp lib/Rest/Handler.cpp \
lib/Rest/HttpRequest.cpp lib/Rest/HttpRequestPlain.cpp \
lib/Rest/HttpResponse.cpp lib/Rest/Initialise.cpp \
lib/Rest/JsonContainer.cpp lib/Rest/SslInterface.cpp \
lib/Rest/Url.cpp lib/ShapedJson/json-shaper.c \
lib/ShapedJson/shape-accessor.c lib/ShapedJson/shaped-json.c \
lib/Statistics/statistics.cpp lib/Utilities/LineEditor.cpp \
lib/Utilities/ScriptLoader.cpp lib/Variant/VariantArray.cpp \
lib/Variant/VariantBlob.cpp lib/Variant/VariantBoolean.cpp \
lib/Variant/VariantDate.cpp lib/Variant/VariantDatetime.cpp \
lib/Variant/VariantDouble.cpp lib/Variant/VariantFloat.cpp \
lib/Variant/VariantInt16.cpp lib/Variant/VariantInt32.cpp \
lib/Variant/VariantInt64.cpp lib/Variant/VariantInt8.cpp \
lib/Variant/VariantMatrix2.cpp lib/Variant/VariantNull.cpp \
lib/Variant/VariantObject.cpp lib/Variant/VariantString.cpp \
lib/Variant/VariantUInt16.cpp lib/Variant/VariantUInt32.cpp \
lib/Variant/VariantUInt64.cpp lib/Variant/VariantUInt8.cpp \
lib/Variant/VariantVector.cpp $(am__append_9)
lib/ProtocolBuffers/arangodb.pb.cpp lib/Rest/AnyServer.cpp \
lib/Rest/EndpointList.cpp lib/Rest/EndpointSpecification.cpp \
lib/Rest/Handler.cpp lib/Rest/HttpRequest.cpp \
lib/Rest/HttpRequestPlain.cpp lib/Rest/HttpResponse.cpp \
lib/Rest/Initialise.cpp lib/Rest/JsonContainer.cpp \
lib/Rest/SslInterface.cpp lib/Rest/Url.cpp \
lib/ShapedJson/json-shaper.c lib/ShapedJson/shape-accessor.c \
lib/ShapedJson/shaped-json.c lib/Statistics/statistics.cpp \
lib/Utilities/LineEditor.cpp lib/Utilities/ScriptLoader.cpp \
lib/Variant/VariantArray.cpp lib/Variant/VariantBlob.cpp \
lib/Variant/VariantBoolean.cpp lib/Variant/VariantDate.cpp \
lib/Variant/VariantDatetime.cpp lib/Variant/VariantDouble.cpp \
lib/Variant/VariantFloat.cpp lib/Variant/VariantInt16.cpp \
lib/Variant/VariantInt32.cpp lib/Variant/VariantInt64.cpp \
lib/Variant/VariantInt8.cpp lib/Variant/VariantMatrix2.cpp \
lib/Variant/VariantNull.cpp lib/Variant/VariantObject.cpp \
lib/Variant/VariantString.cpp lib/Variant/VariantUInt16.cpp \
lib/Variant/VariantUInt32.cpp lib/Variant/VariantUInt64.cpp \
lib/Variant/VariantUInt8.cpp lib/Variant/VariantVector.cpp \
$(am__append_9)
################################################################################
### @brief library "libarango.a", client part
@ -1907,8 +1905,6 @@ lib/Rest/$(am__dirstamp):
lib/Rest/$(DEPDIR)/$(am__dirstamp):
@$(MKDIR_P) lib/Rest/$(DEPDIR)
@: > lib/Rest/$(DEPDIR)/$(am__dirstamp)
lib/Rest/AddressPort.$(OBJEXT): lib/Rest/$(am__dirstamp) \
lib/Rest/$(DEPDIR)/$(am__dirstamp)
lib/Rest/AnyServer.$(OBJEXT): lib/Rest/$(am__dirstamp) \
lib/Rest/$(DEPDIR)/$(am__dirstamp)
lib/Rest/EndpointList.$(OBJEXT): lib/Rest/$(am__dirstamp) \
@ -2972,7 +2968,6 @@ mostlyclean-compile:
-rm -f lib/ProtocolBuffers/HttpRequestProtobuf.$(OBJEXT)
-rm -f lib/ProtocolBuffers/arangodb.pb.$(OBJEXT)
-rm -f lib/ProtocolBuffers/bin_zclient-arangodb.pb.$(OBJEXT)
-rm -f lib/Rest/AddressPort.$(OBJEXT)
-rm -f lib/Rest/AnyServer.$(OBJEXT)
-rm -f lib/Rest/EndpointList.$(OBJEXT)
-rm -f lib/Rest/EndpointSpecification.$(OBJEXT)
@ -3238,7 +3233,6 @@ distclean-compile:
@AMDEP_TRUE@@am__include@ @am__quote@lib/ProtocolBuffers/$(DEPDIR)/HttpRequestProtobuf.Po@am__quote@
@AMDEP_TRUE@@am__include@ @am__quote@lib/ProtocolBuffers/$(DEPDIR)/arangodb.pb.Po@am__quote@
@AMDEP_TRUE@@am__include@ @am__quote@lib/ProtocolBuffers/$(DEPDIR)/bin_zclient-arangodb.pb.Po@am__quote@
@AMDEP_TRUE@@am__include@ @am__quote@lib/Rest/$(DEPDIR)/AddressPort.Po@am__quote@
@AMDEP_TRUE@@am__include@ @am__quote@lib/Rest/$(DEPDIR)/AnyServer.Po@am__quote@
@AMDEP_TRUE@@am__include@ @am__quote@lib/Rest/$(DEPDIR)/EndpointList.Po@am__quote@
@AMDEP_TRUE@@am__include@ @am__quote@lib/Rest/$(DEPDIR)/EndpointSpecification.Po@am__quote@

10
arangod/Documentation/command-line-options.dox
View File

@ -45,8 +45,7 @@
/// </li>
/// <li>@ref CommandLineArango
/// <ul>
/// <li>@ref CommandLineArangoHttpPort "server.http-port"</li>
/// <li>@ref CommandLineArangoAdminPort "server.admin-port"</li>
/// <li>@ref CommandLineArangoEndpoint "server.endpoint"</li>
/// <li>@ref CommandLineArangoDirectory "database.directory"</li>
/// <li>@ref CommandLineArangoMaximalJournalSize "database.maximal-journal-size"</li>
/// <li>@ref CommandLineArangoRemoveOnDrop "database.remove-on-drop"</li>
@ -156,11 +155,8 @@
/// @section CommandLineArango Command-Line Options for the ArangoDB
////////////////////////////////////////////////////////////////////
///
/// @anchor CommandLineArangoHttpPort
/// @copydetails triagens::arango::ArangoServer::_httpPort
///
/// @anchor CommandLineArangoAdminPort
/// @copydetails triagens::arango::ArangoServer::_adminPort
/// @anchor CommandLineArangoEndpoint
/// @copydetails triagens::arango::ArangoServer::_endpoints
///
/// @anchor CommandLineArangoDirectory
/// @copydetails triagens::arango::ArangoServer::_databasePath

7
lib/Rest/EndpointSpecification.cpp
View File

@ -30,10 +30,11 @@
#include <netinet/in.h>
#include <sys/file.h>
#include "BasicsC/socket-utils.h"
#include "Basics/StringUtils.h"
#include "Basics/FileUtils.h"
#include "Logger/Logger.h"
#include "BasicsC/socket-utils.h"
using namespace triagens::basics;
using namespace triagens::rest;
@ -217,6 +218,8 @@ bool EndpointSpecification::setSocketFlags (socket_t _socket) {
/// @}
////////////////////////////////////////////////////////////////////////////////
#ifdef TRI_HAVE_LINUX_SOCKETS
// -----------------------------------------------------------------------------
// --SECTION-- EndpointSpecificationUnix
// -----------------------------------------------------------------------------
@ -380,6 +383,8 @@ bool EndpointSpecificationUnix::initIncoming (socket_t incoming) {
/// @}
////////////////////////////////////////////////////////////////////////////////
#endif
// -----------------------------------------------------------------------------
// --SECTION-- EndpointSpecificationIp
// -----------------------------------------------------------------------------

30
lib/Rest/EndpointSpecification.h
View File

@ -34,7 +34,11 @@
#include <arpa/inet.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#ifdef TRI_HAVE_LINUX_SOCKETS
#include <sys/un.h>
#endif
#include <sys/socket.h>
#include <netdb.h>
@ -42,11 +46,6 @@
// --SECTION-- EndpointSpecification
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Rest
/// @{
////////////////////////////////////////////////////////////////////////////////
namespace triagens {
namespace rest {
@ -65,9 +64,11 @@ namespace triagens {
enum EndpointDomainType {
ENDPOINT_UNKNOWN = 0,
#ifdef TRI_HAVE_LINUX_SOCKETS
ENDPOINT_UNIX,
#endif
ENDPOINT_IPV4,
ENDPOINT_IPV6,
ENDPOINT_UNIX
ENDPOINT_IPV6
};
////////////////////////////////////////////////////////////////////////////////
@ -76,10 +77,6 @@ namespace triagens {
class EndpointSpecification {
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- constructors / destructors
// -----------------------------------------------------------------------------
@ -267,12 +264,15 @@ namespace triagens {
////////////////////////////////////////////////////////////////////////////////
string _specification;
};
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
};
#ifdef TRI_HAVE_LINUX_SOCKETS
// -----------------------------------------------------------------------------
// --SECTION-- EndpointSpecificationUnix
// -----------------------------------------------------------------------------
@ -396,6 +396,8 @@ namespace triagens {
};
#endif
// -----------------------------------------------------------------------------
// --SECTION-- EndpointSpecificationIp
// -----------------------------------------------------------------------------
@ -667,10 +669,6 @@ namespace triagens {
}
}
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
#endif
// Local Variables: