Commit a67fdc33 authored by Alexander Wiebel's avatar Alexander Wiebel

[DOC] added some missing doxygen documentation

parent a2b542cf
......@@ -38,7 +38,7 @@
*/
class WCondition // NOLINT
{
friend class WCondition_test;
friend class WCondition_test; //!< Access for test class.
public:
/**
* Shared pointer type for WCondition.
......
......@@ -39,7 +39,7 @@
*/
class WConditionOneShot: public WCondition
{
friend class WConditionOneShot_test;
friend class WConditionOneShot_test; //!< Access for test class.
public:
/**
* Default constructor.
......
......@@ -51,7 +51,7 @@
*/
class WItemSelector // NOLINT
{
friend class WItemSelection;
friend class WItemSelection; //!< Only class allowed to instanciate this class.
public:
/**
* The type used for storing index lists. It is a list of integer correlating with the elements in the managed WItemSelection class.
......@@ -295,4 +295,3 @@ private:
std::ostream& operator<<( std::ostream& out, const WItemSelector& other );
#endif // WITEMSELECTOR_H
......@@ -238,4 +238,3 @@ namespace WStructuredTextParser
return ast;
}
}
......@@ -268,7 +268,7 @@ namespace WStructuredTextParser
*/
class StructuredValueTree
{
friend class WStructuredTextParserTest;
friend class WStructuredTextParserTest; //!< Access for test class.
public:
/**
* This char is used as separator for identifying values in the tree. NEVER change this value.
......
......@@ -33,6 +33,7 @@
template< std::size_t n >
struct WFactorial
{
//! compile time factorial computation result
enum
{
value = n * WFactorial< n - 1 >::value
......@@ -45,6 +46,7 @@ struct WFactorial
template<>
struct WFactorial< 0 >
{
//! compile time factorial computation basis value
enum
{
value = 1
......
......@@ -164,7 +164,7 @@ class WTensorBase
*/
BOOST_STATIC_ASSERT( dim != 0 );
// Make the appropriate tensor of order + 1 a friend, so it has access to the getPos() member.
//! Make the appropriate tensor of order + 1 a friend, so it has access to the getPos() member.
friend class WTensorBase< order + 1, dim, Data_T >;
//! make the test class a friend
......@@ -313,7 +313,6 @@ private:
static inline std::size_t getPos( Index_T pos[] );
//! Stores all elements.
//std::vector< Data_T > m_data;
boost::array< Data_T, dataSize > m_data;
};
......
......@@ -148,10 +148,10 @@ private:
template< typename ValueT, size_t Rows, size_t Cols, ValueStoreTemplate ValueStoreT = ValueStore >
class WMatrixFixed
{
//! the test is a friend
//! Access for test class
friend class WMatrixFixedTest;
// this is needed for access to the storage object of another matrix
//! This is needed for access to the storage object of another matrix
template< typename ValueTT, size_t Rowss, size_t Colss, ValueStoreTemplate ValueStoreTT >
friend class WMatrixFixed;
......
......@@ -119,7 +119,7 @@ public:
*/
class ColorScheme: public WItemSelectionItem
{
friend class WDataSetFibers;
friend class WDataSetFibers; //!< Grant access for its outer class
public:
/**
* different kinds of color arrays can be used in this class. This enum defines their possible types.
......@@ -1284,4 +1284,3 @@ private:
};
#endif // WDATASETFIBERS_H
......@@ -59,7 +59,7 @@
template< typename T >
class WGridRegular3DTemplate : public WGrid // NOLINT
{
// this (friend) is necessary to allow casting
//! this (friend) is necessary to allow casting
template <class U>
friend class WGridRegular3DTemplate;
/**
......
......@@ -39,7 +39,7 @@
*/
class WGEBorderLayout: public WGEGroupNode
{
friend class SafeUpdateCallback;
friend class SafeUpdateCallback; //!< Grant access for its inner class
public:
/**
* Default constructor.
......
......@@ -49,8 +49,8 @@ class WModuleOutputConnector;
*/
class WModuleConnector: public boost::enable_shared_from_this<WModuleConnector>
{
friend class WModuleConnectorTest; //!< Access for test class.
friend class WModuleProjectFileCombiner;
friend class WModuleConnectorTest; //!< Access for test class.
friend class WModuleProjectFileCombiner; //!< Access for creating a module graph automatically.
public:
/**
......@@ -331,4 +331,3 @@ private:
};
#endif // WMODULECONNECTOR_H
......@@ -43,7 +43,7 @@
*/
class WUIWidgetBase
{
friend class WUIWidgetFactory;
friend class WUIWidgetFactory; //!< The factory needs to be able to call the constructor
public:
/**
* Convenience typedef for a boost::shared_ptr< WUIWidgetBase >.
......@@ -237,4 +237,3 @@ private:
};
#endif // WUIWIDGETBASE_H
......@@ -34,12 +34,10 @@
#include "../WTalairachConverter.h"
/**
* Tests the Talailrach converter class
* Tests the Talairach converter class
*/
class WTalairachConverterTest : public CxxTest::TestSuite
{
friend class WTalairachConverter;
public:
/**
* Set up the special points of the Talairach coordinate system
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment