Commit f17d7714 authored by Robin Eschbach's avatar Robin Eschbach
Browse files

[DOC #99] fixing doc

parent 38f13c98
......@@ -95,19 +95,19 @@ public:
int getEventID();
private:
int m_parentID = -1; //<! The parentID index.
int m_parentID = -1; //!< The parentID index.
int m_posX = -1; //<! The posX index.
int m_posX = -1; //!< The posX index.
int m_posY = -1; //<! The posY index.
int m_posY = -1; //!< The posY index.
int m_posZ = -1; //<! The posZ index.
int m_posZ = -1; //!< The posZ index.
int m_edep = -1; //<! The edep index.
int m_edep = -1; //!< The edep index.
int m_PDGEncoding = -1; //<! The PDGEncoding index.
int m_PDGEncoding = -1; //!< The PDGEncoding index.
int m_eventID = -1; //<! The eventID index.
int m_eventID = -1; //!< The eventID index.
};
#endif // WMCONVERTERINDEXES_H
......@@ -109,21 +109,21 @@ public:
SPSizeVector getEventIDs();
private:
SPFloatVector m_vertices; //<! The vertices.
SPFloatVector m_vertices; //!< The vertices.
SPFloatVector m_sizes; //<! The sizes.
SPFloatVector m_sizes; //!< The sizes.
SPFloatVector m_colors; //<! The colors.
SPFloatVector m_colors; //!< The colors.
SPFloatVector m_edeps; //<! The edeps.
SPFloatVector m_edeps; //!< The edeps.
SPSizeVector m_fiberStartIndexes; //<! The fiber start indexes.
SPSizeVector m_fiberStartIndexes; //!< The fiber start indexes.
SPSizeVector m_fiberLengths; //<! The fiber lengths.
SPSizeVector m_fiberLengths; //!< The fiber lengths.
SPSizeVector m_verticesReverse; //<! The reverse vertices.
SPSizeVector m_verticesReverse; //!< The reverse vertices.
SPSizeVector m_eventIDs; //<! the event IDs.
SPSizeVector m_eventIDs; //!< the event IDs.
};
#endif // WMCONVERTERVECTORS_H
......@@ -145,8 +145,10 @@ private:
/**
* checks whether the requirements are fulfilled
* checks whether the requirements are fulfilled.
* \param dataRow the row to check.
* \return true The row can be displayed.
* \return false The row can not be displayed.
*/
bool canShow( WDataSetCSV::Content::iterator dataRow );
......
......@@ -109,8 +109,8 @@ public:
/**
* checks whether columns are available
*
* \return true if column is available . false if column is not available
* \param columnName THe name of the column.
* \return true if column is available, false if column is not available
*/
bool isColumnAvailable( std::string columnName );
......
......@@ -68,7 +68,7 @@ public:
void createProperties();
/**
* Get reference of selectable column types
* \return boost::shared_ptr< WItemSelection > Reference of selectable column types
*/
boost::shared_ptr< WItemSelection > getColumnItems();
......@@ -116,12 +116,16 @@ private:
WMColumnPropertyHandler::CallbackPtr m_externEventMethod;
/**
* Creates the individual WItemSelection
* Creates the individual WItemSelection
* \param headerName The name of the selection
* \param notifier The notifier for the selection
* \return WPropSelection The created selection
*/
WPropSelection addHeaderProperty( std::string headerName, WPropertyBase::PropertyChangeNotifierType notifier );
/**
* Event function when WItemSelection is triggered
* Event function when WItemSelection is triggered
* \param property The changed property
*/
void propertyNotifier( WPropertyBase::SPtr property );
......
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