1
0
Fork 0

removed old-style comments

This commit is contained in:
Jan Steemann 2014-06-11 17:48:09 +02:00
parent fa6e98d94c
commit 86171cd881
4 changed files with 16 additions and 108 deletions

View File

@ -36,7 +36,6 @@
#include "Ahuacatl/ahuacatl-access-optimiser.h"
#include "Ahuacatl/ahuacatl-context.h"
struct TRI_vector_pointer_s;
struct TRI_vector_pointer_s* TRI_GetCoordinatorIndexes (char const*, char const*);
@ -44,11 +43,6 @@ struct TRI_vector_pointer_s* TRI_GetCoordinatorIndexes (char const*, char const*
// --SECTION-- private functions
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief free indexes
////////////////////////////////////////////////////////////////////////////////
@ -171,19 +165,10 @@ static bool SetupCollections (TRI_aql_context_t* const context) {
return result;
}
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- public functions
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief get the JSON representation of a collection hint
////////////////////////////////////////////////////////////////////////////////
@ -412,10 +397,6 @@ TRI_vector_pointer_t* TRI_GetIndexesCollectionAql (TRI_aql_context_t* context,
}
}
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// Local Variables:
// mode: outline-minor
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|/// @page\\|// --SECTION--\\|/// @\\}"

View File

@ -43,30 +43,16 @@ struct TRI_vector_pointer_s;
// --SECTION-- defines
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief max number of collections usable in a query
////////////////////////////////////////////////////////////////////////////////
#define AQL_MAX_COLLECTIONS 32
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- public types
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief a collection container
///
@ -76,7 +62,7 @@ struct TRI_vector_pointer_s;
////////////////////////////////////////////////////////////////////////////////
typedef struct TRI_aql_collection_s {
TRI_vocbase_col_t* _collection; // this might be NULL !
TRI_vocbase_col_t* _collection; // this might be nullptr !
char* _name;
struct TRI_vector_pointer_s* _availableIndexes;
}
@ -100,19 +86,10 @@ typedef struct TRI_aql_collection_hint_s {
}
TRI_aql_collection_hint_t;
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- public functions
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief get the JSON representation of a collection hint
////////////////////////////////////////////////////////////////////////////////
@ -164,10 +141,6 @@ bool TRI_AddCollectionAql (struct TRI_aql_context_s*,
struct TRI_vector_pointer_s* TRI_GetIndexesCollectionAql (struct TRI_aql_context_s*,
TRI_aql_collection_t*);
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
#endif
// Local Variables:

View File

@ -31,30 +31,25 @@
// --SECTION-- constructors / destructors
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief register a new variable
////////////////////////////////////////////////////////////////////////////////
TRI_aql_variable_t* TRI_CreateVariableAql (const char* const name,
TRI_aql_node_t* const definingNode) {
TRI_aql_variable_t* TRI_CreateVariableAql (char const* name,
TRI_aql_node_t* definingNode) {
TRI_aql_variable_t* variable;
variable = (TRI_aql_variable_t*) TRI_Allocate(TRI_UNKNOWN_MEM_ZONE, sizeof(TRI_aql_variable_t), false);
if (variable == NULL) {
return NULL;
if (variable == nullptr) {
return nullptr;
}
variable->_name = TRI_DuplicateStringZ(TRI_UNKNOWN_MEM_ZONE, name);
if (variable->_name == NULL) {
if (variable->_name == nullptr) {
TRI_FreeVariableAql(variable);
return NULL;
return nullptr;
}
variable->_definingNode = definingNode;
@ -68,29 +63,20 @@ TRI_aql_variable_t* TRI_CreateVariableAql (const char* const name,
/// @brief free an existing variable
////////////////////////////////////////////////////////////////////////////////
void TRI_FreeVariableAql (TRI_aql_variable_t* const variable) {
TRI_ASSERT(variable);
void TRI_FreeVariableAql (TRI_aql_variable_t* variable) {
TRI_ASSERT(variable != nullptr);
if (variable->_name) {
if (variable->_name != nullptr) {
TRI_Free(TRI_UNKNOWN_MEM_ZONE, variable->_name);
}
TRI_Free(TRI_UNKNOWN_MEM_ZONE, variable);
}
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- public functions
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief hash variable
////////////////////////////////////////////////////////////////////////////////
@ -114,13 +100,12 @@ bool TRI_EqualVariableAql (TRI_associative_pointer_t* array,
return TRI_EqualString(static_cast<char const*>(key), variable->_name);
}
////////////////////////////////////////////////////////////////////////////////
/// @brief checks if a variable name follows the required naming convention
////////////////////////////////////////////////////////////////////////////////
bool TRI_IsValidVariableNameAql (const char* const name) {
TRI_ASSERT(name);
bool TRI_IsValidVariableNameAql (char const* name) {
TRI_ASSERT(name != nullptr);
if (strlen(name) == 0) {
// name must be at least one char long
@ -136,10 +121,6 @@ bool TRI_IsValidVariableNameAql (const char* const name) {
return true;
}
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// Local Variables:
// mode: outline-minor
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|/// @page\\|// --SECTION--\\|/// @\\}"

View File

@ -40,11 +40,6 @@
// --SECTION-- public types
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief a query variable
////////////////////////////////////////////////////////////////////////////////
@ -55,45 +50,27 @@ typedef struct TRI_aql_variable_s {
}
TRI_aql_variable_t;
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- constructors / destructors
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief register a new variable
////////////////////////////////////////////////////////////////////////////////
TRI_aql_variable_t* TRI_CreateVariableAql (const char* const,
TRI_aql_node_t* const);
TRI_aql_variable_t* TRI_CreateVariableAql (char const*,
TRI_aql_node_t*);
////////////////////////////////////////////////////////////////////////////////
/// @brief free an existing variable
////////////////////////////////////////////////////////////////////////////////
void TRI_FreeVariableAql (TRI_aql_variable_t* const);
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
void TRI_FreeVariableAql (TRI_aql_variable_t*);
// -----------------------------------------------------------------------------
// --SECTION-- public functions
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup Ahuacatl
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief hash variable
////////////////////////////////////////////////////////////////////////////////
@ -110,11 +87,7 @@ bool TRI_EqualVariableAql (TRI_associative_pointer_t*, void const*, void const*)
/// @brief checks if a variable name follows the required naming convention
////////////////////////////////////////////////////////////////////////////////
bool TRI_IsValidVariableNameAql (const char* const);
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
bool TRI_IsValidVariableNameAql (char const*);
#endif