| [opengtl-commits] [392] some doxygen work |
[ Thread Index |
Date Index
| More lists.tuxfamily.org/opengtl-commits Archives
]
Revision: 392
Author: cyrille
Date: 2008-09-13 23:26:11 +0200 (Sat, 13 Sep 2008)
Log Message:
-----------
some doxygen work
Modified Paths:
--------------
trunk/OpenGTL/OpenGTL/GTLCore/AST/AccessorExpression.h
trunk/OpenGTL/OpenGTL/GTLCore/AST/ConvertExpression.h
trunk/OpenGTL/OpenGTL/GTLCore/AST/CoumpoundExpression.h
trunk/OpenGTL/OpenGTL/GTLCore/AST/GarbageCollectionStatement.h
trunk/OpenGTL/OpenGTL/GTLCore/Array.h
trunk/OpenGTL/OpenGTL/GTLCore/Buffer.h
trunk/OpenGTL/OpenGTL/GTLCore/CompilerBase_p.h
trunk/OpenGTL/OpenGTL/GTLCore/ConvertCenter_p.h
trunk/OpenGTL/OpenGTL/GTLCore/FunctionCaller_p.h
trunk/OpenGTL/OpenGTL/GTLCore/FunctionCaller_p_p.h
trunk/OpenGTL/OpenGTL/GTLCore/Function_p.h
trunk/OpenGTL/OpenGTL/GTLCore/Optimiser.h
trunk/OpenGTL/OpenGTL/GTLCore/Optimiser_p.cpp
trunk/OpenGTL/OpenGTL/GTLCore/Optimiser_p.h
trunk/OpenGTL/OpenGTL/GTLCore/Parameter.h
trunk/OpenGTL/OpenGTL/GTLCore/ParserBase_p.h
trunk/OpenGTL/OpenGTL/GTLCore/ScopedName.h
trunk/OpenGTL/OpenGTL/GTLCore/Token_p.h
trunk/OpenGTL/OpenGTL/GTLCore/Type.h
trunk/OpenGTL/OpenGTL/GTLCore/TypeManager.h
trunk/OpenGTL/OpenGTL/GTLCore/TypeManager_p.h
trunk/OpenGTL/OpenGTL/GTLCore/Type_p.h
trunk/OpenGTL/OpenGTL/GTLCore/Value.h
trunk/OpenGTL/OpenGTL/GTLCore/VariableNG_p.h
trunk/OpenGTL/OpenGTL/GTLCore/VariablesManager_p.h
Modified: trunk/OpenGTL/OpenGTL/GTLCore/AST/AccessorExpression.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/AST/AccessorExpression.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/AST/AccessorExpression.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -26,6 +26,11 @@
namespace GTLCore {
class ExpressionResult;
namespace AST {
+ /**
+ * @internal
+ * This is the base class for \ref Expression that give acces to a part of a structure/array.
+ * @ingroup GTLCore_AST
+ */
class AccessorExpression : public Expression {
public:
virtual GTLCore::ExpressionResult generateValue( GenerationContext& _gc, llvm::BasicBlock* bb ) const;
@@ -34,6 +39,11 @@
virtual bool allocatedInMemory() const = 0;
virtual llvm::BasicBlock* affect( GenerationContext& _gc, llvm::BasicBlock* _bb, const ExpressionResult& _value );
};
+ /**
+ * @internal
+ * Access the size of an array.
+ * @ingroup GTLCore_AST
+ */
class ArraySizeAccessorExpression : public AccessorExpression {
public:
ArraySizeAccessorExpression(AccessorExpression* _parent );
@@ -45,6 +55,11 @@
private:
AccessorExpression * m_parent;
};
+ /**
+ * @internal
+ * Access a member of a structure.
+ * @ingroup GTLCore_AST
+ */
class StructAccessorExpression : public AccessorExpression {
public:
StructAccessorExpression(AccessorExpression* _parent, unsigned int _index);
@@ -59,6 +74,11 @@
AccessorExpression * m_parent;
unsigned int m_index;
};
+ /**
+ * @internal
+ * Access an index of an array.
+ * @ingroup GTLCore_AST
+ */
class ArrayAccessorExpression : public AccessorExpression {
public:
ArrayAccessorExpression(AccessorExpression * _parent, Expression* _index);
@@ -73,6 +93,11 @@
AccessorExpression * m_parent;
Expression* m_index;
};
+ /**
+ * @internal
+ * Access the content of a variable.
+ * @ingroup GTLCore_AST
+ */
class VariableAccessorExpression : public AccessorExpression {
public:
VariableAccessorExpression(GTLCore::VariableNG* _variable );
@@ -86,6 +111,11 @@
private:
GTLCore::VariableNG* m_variable;
};
+ /**
+ * @internal
+ * Call a function member of a structure.
+ * @ingroup GTLCore_AST
+ */
class FunctionMemberAccessorExpression : public AccessorExpression {
public:
FunctionMemberAccessorExpression( AccessorExpression * _parent,
Modified: trunk/OpenGTL/OpenGTL/GTLCore/AST/ConvertExpression.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/AST/ConvertExpression.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/AST/ConvertExpression.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -24,6 +24,11 @@
namespace GTLCore {
namespace AST {
+ /**
+ * @internal
+ * This is the base class of \ref Expression that allow to convert from one type to an other.
+ * @ingroup GTLCore_AST
+ */
class ConvertExpression : public Expression {
public:
ConvertExpression( AST::Expression* _value );
@@ -35,6 +40,12 @@
private:
AST::Expression* m_value;
};
+ /**
+ * @internal
+ * This is the so called 'Default' conversion expression which handles convertion from one llvm native
+ * type to an other.
+ * @ingroup GTLCore_AST
+ */
class DefaultConvertExpression : public ConvertExpression {
public:
DefaultConvertExpression( AST::Expression* _value, const GTLCore::Type* _dstType );
Modified: trunk/OpenGTL/OpenGTL/GTLCore/AST/CoumpoundExpression.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/AST/CoumpoundExpression.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/AST/CoumpoundExpression.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -25,6 +25,10 @@
namespace GTLCore {
namespace AST {
+ /**
+ * @internal
+ * @ingroup GTLCore_AST
+ */
class CoumpoundExpression : public Expression {
public:
CoumpoundExpression( const GTLCore::Type* _type, const std::vector<Expression*>& _expressions);
Modified: trunk/OpenGTL/OpenGTL/GTLCore/AST/GarbageCollectionStatement.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/AST/GarbageCollectionStatement.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/AST/GarbageCollectionStatement.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -24,6 +24,10 @@
namespace GTLCore {
namespace AST {
+ /**
+ * @internal
+ * @ingroup GTLCore_AST
+ */
class GarbageCollectionStatement : public Statement {
public:
GarbageCollectionStatement( llvm::Value* _pointer, const GTLCore::Type* _type );
Modified: trunk/OpenGTL/OpenGTL/GTLCore/Array.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/Array.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/Array.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -37,6 +37,10 @@
/**
* Initialise an array of the given size.
* @param size size of the array in byte
+ *
+ * @code
+ * Array array(10); // Create an array of 10 bytes
+ * @endcode
*/
Array(int size);
/**
Modified: trunk/OpenGTL/OpenGTL/GTLCore/Buffer.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/Buffer.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/Buffer.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -44,6 +44,10 @@
virtual const char * rawData() const =0;
/**
* @return a constant pointer to the buffer casted to the parameter given as argument
+ * @code
+ * Array array(10 * sizeof(double)); // Create an array of 10 doubles
+ * array.data<double>() == (reinterpret_cast<double*>(array.rawData()) + 10) == (reinterpret_cast<double*>(array.rawData() + 10 *sizeof(double)))
+ * @endcode
*/
template<typename _T_>
inline const _T_* data() const { return reinterpret_cast<const _T_*>( rawData() ); }
Modified: trunk/OpenGTL/OpenGTL/GTLCore/CompilerBase_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/CompilerBase_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/CompilerBase_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -32,6 +32,11 @@
namespace AST {
class Expression;
}
+ /**
+ * @internal
+ * Base class for compilers, it provides some basic information/functionnalities to the \ref ParserBase
+ * @ingroup GTLCore
+ */
class CompilerBase {
public:
CompilerBase();
Modified: trunk/OpenGTL/OpenGTL/GTLCore/ConvertCenter_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/ConvertCenter_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/ConvertCenter_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -28,16 +28,32 @@
class Expression;
}
class Type;
+ /**
+ * @internal
+ * This class allows to create the \ref AST::ConvertExpression that can convert between two different types.
+ * @ingroup GTLCore
+ */
class ConvertExpressionFactory {
public:
ConvertExpressionFactory( );
virtual ~ConvertExpressionFactory();
+ /**
+ * Create the \ref AST::ConvertExpression that can convert the given @p value to the given @p _dstType
+ */
virtual AST::ConvertExpression* create( AST::Expression* value, const GTLCore::Type* _dstType ) const = 0;
+ /**
+ * @return true if this \ref ConvertExpressionFactory can convert between @p srcType and @p dstType
+ */
virtual bool canConvertBetween( const GTLCore::Type* srcType, const GTLCore::Type* dstType) const = 0;
private:
struct Private;
Private* const d;
};
+ /**
+ * @internal
+ * This class contains informations about all the possible conversion.
+ * @ingroup GTLCore
+ */
class ConvertCenter {
public:
ConvertCenter();
Modified: trunk/OpenGTL/OpenGTL/GTLCore/FunctionCaller_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/FunctionCaller_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/FunctionCaller_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -34,6 +34,7 @@
* This is use to provide fast and efficient call to CTL functions,
* unlike what llvm's JIT provides.
* @internal
+ * @ingroup GTLCore
*/
class FunctionCaller {
public:
Modified: trunk/OpenGTL/OpenGTL/GTLCore/FunctionCaller_p_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/FunctionCaller_p_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/FunctionCaller_p_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -31,6 +31,8 @@
/**
* This function is used as a fall back when everything else has fail.
* It can be very slow.
+ * @ingroup GTLCore
+ * @internal
*/
class FunctionCallerFallBack : public FunctionCaller {
public:
Modified: trunk/OpenGTL/OpenGTL/GTLCore/Function_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/Function_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/Function_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -35,7 +35,7 @@
/**
* @internal
* This class is not part of the public API of OpenCTL.
- *
+ * @ingroup GTLCore
*/
struct Function::Private
{
Modified: trunk/OpenGTL/OpenGTL/GTLCore/Optimiser.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/Optimiser.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/Optimiser.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -30,6 +30,10 @@
}
namespace GTLCore {
+ /**
+ * This class contains information about the current level of optimization.
+ * @ingroup GTLCore
+ */
class Optimiser{
friend class OpenCTL::Compiler;
friend class OpenCTL::Program;
Modified: trunk/OpenGTL/OpenGTL/GTLCore/Optimiser_p.cpp
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/Optimiser_p.cpp 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/Optimiser_p.cpp 2008-09-13 21:26:11 UTC (rev 392)
@@ -75,7 +75,7 @@
Optimiser::Private::Private() : m_passManager(0)
{
- setLevel( 2 );
+ setLevel( 0 );
}
Optimiser::Private::~Private()
Modified: trunk/OpenGTL/OpenGTL/GTLCore/Optimiser_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/Optimiser_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/Optimiser_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -31,6 +31,12 @@
}
namespace GTLCore {
+ /**
+ * @internal
+ * This class is mainly used to maintain the \ref llvm::PassManager used for optimizing the generated modules depending
+ * on the current optimization level.
+ * @ingroup GTLCore
+ */
class Optimiser::Private {
friend class Optimiser;
public:
Modified: trunk/OpenGTL/OpenGTL/GTLCore/Parameter.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/Parameter.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/Parameter.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -27,6 +27,7 @@
class Value;
/**
* This class describes one argument to a function.
+ * @ingroup GTLCore
*/
class Parameter {
public:
Modified: trunk/OpenGTL/OpenGTL/GTLCore/ParserBase_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/ParserBase_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/ParserBase_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -46,6 +46,7 @@
/**
* @internal
* This is the base class for OpenGTL's Parser.
+ * @ingroup GTLCore
*/
class ParserBase {
public:
Modified: trunk/OpenGTL/OpenGTL/GTLCore/ScopedName.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/ScopedName.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/ScopedName.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -23,6 +23,10 @@
#include <GTLCore/String.h>
namespace GTLCore {
+ /**
+ * Define a name (function, variable...) and its namespace.
+ * @ingroup GTLCore
+ */
class ScopedName {
public:
ScopedName();
Modified: trunk/OpenGTL/OpenGTL/GTLCore/Token_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/Token_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/Token_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -27,6 +27,7 @@
/**
* This structure holds information concerning a token, like position (line / column),
* type or value (for string, integer, float or identifier).
+ * @ingroup GTLCore
*/
struct Token {
/**
Modified: trunk/OpenGTL/OpenGTL/GTLCore/Type.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/Type.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/Type.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -44,7 +44,7 @@
}
/**
* This class holds information about a type.
- *
+ * @ingroup GTLCore
*/
class Type {
friend class ArrayAccessor;
Modified: trunk/OpenGTL/OpenGTL/GTLCore/TypeManager.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/TypeManager.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/TypeManager.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -28,6 +28,10 @@
}
namespace GTLCore {
+ /**
+ * This class gives access to all types used by a module.
+ * @ingroup GTLCore
+ */
class TypeManager {
friend class ParserBase;
friend class OpenShiva::Wrapper;
Modified: trunk/OpenGTL/OpenGTL/GTLCore/TypeManager_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/TypeManager_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/TypeManager_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -25,6 +25,11 @@
#include <map>
namespace GTLCore {
+ /**
+ * @internal
+ *
+ * @ingroup GTLCore
+ */
struct TypeManager::Private {
std::map< GTLCore::String, const GTLCore::Type*> knownTypes;
static std::map< const GTLCore::Type*, const GTLCore::Type*> knownArrays;
Modified: trunk/OpenGTL/OpenGTL/GTLCore/Type_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/Type_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/Type_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -29,6 +29,11 @@
namespace GTLCore {
class Function;
class Visitor;
+ /**
+ * @internal
+ *
+ * @ingroup GTLCore
+ */
class Type::StructFunctionMember {
public:
/**
Modified: trunk/OpenGTL/OpenGTL/GTLCore/Value.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/Value.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/Value.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -24,6 +24,7 @@
class Type;
/**
* Value is a class use to hold a primitive value, like a float, an integer or a boolean.
+ * @ingroup GTLCore
*/
class Value {
public:
Modified: trunk/OpenGTL/OpenGTL/GTLCore/VariableNG_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/VariableNG_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/VariableNG_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -32,6 +32,7 @@
class ExpressionResult;
class Type;
/**
+ * @internal
* VariableNG is the class for manipulating variables, getting and settng the values.
* @ingroup GTLCore
*/
Modified: trunk/OpenGTL/OpenGTL/GTLCore/VariablesManager_p.h
===================================================================
--- trunk/OpenGTL/OpenGTL/GTLCore/VariablesManager_p.h 2008-09-13 21:07:47 UTC (rev 391)
+++ trunk/OpenGTL/OpenGTL/GTLCore/VariablesManager_p.h 2008-09-13 21:26:11 UTC (rev 392)
@@ -31,8 +31,10 @@
class Statement;
}
/**
+ * @internal
* The variable manager is a class that manages the variable of a function
* when parsing code.
+ * @ingroup GTLCore
*/
class VariablesManager {
public: