Commit 7f801fd9 authored by Jan Möbius's avatar Jan Möbius

Fixed documentation warnings

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@14225 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 132429f1
......@@ -341,17 +341,6 @@ void DataControlPlugin::slotObjectPropertiesChanged( int _identifier ){
}
//******************************************************************************
/** \brief Update the model if an object was deleted
*
* @param _identifier id of an object
*/
void DataControlPlugin::slotObjectUpdated( int /*_identifier*/ , const UpdateType& /*_type*/ ){
}
//******************************************************************************
/** \brief Update the model if a file has been opened
......@@ -431,8 +420,9 @@ void DataControlPlugin::slotKeyEvent( QKeyEvent* _event )
/** \brief emit the right updates when the model changed
*
* @param topLeft index in the model
* @param _column hmm
* @param _id Object id that was changed
* @param _column Which column changed
* @param _value What is the new value?
*/
void DataControlPlugin::slotDataChanged ( int _id, int _column, const QVariant& _value)
{
......@@ -473,8 +463,8 @@ void DataControlPlugin::slotDataChanged ( int _id, int _column, const QVariant&
/** \brief Gets called when an object was moved via drag n drop
*
* @param _id id of the object
* @param _parentId id of the new parent
* @param _id id of the object
* @param _newParentId id of the new parent
*/
void DataControlPlugin::slotMoveBaseObject(int _id, int _newParentId){
......@@ -681,7 +671,8 @@ void DataControlPlugin::saveIniFileOptions( INIFile& _ini ) {
/** \brief Recursively update a column up to the root of the tree
*
* @param _obj object to start with
* @param _obj Object to start with
* @param _column Column to propagate
*/
void DataControlPlugin::propagateUpwards(BaseObject* _obj, int _column ){
......
......@@ -105,7 +105,6 @@ class DataControlPlugin : public QObject, BaseInterface, ToolboxInterface, KeyIn
// BaseInterface
void initializePlugin();
void pluginsInitialized();
void slotObjectUpdated ( int _identifier , const UpdateType& _type);
void slotVisibilityChanged ( int _identifier );
void slotObjectSelectionChanged ( int _identifier );
void slotObjectPropertiesChanged( int _identifier );
......@@ -225,7 +224,10 @@ class DataControlPlugin : public QObject, BaseInterface, ToolboxInterface, KeyIn
///Called by the popup menu to set material properties
void slotMaterialProperties();
///Called when the material properties were changed inside the material dialog
/** \brief Called when the material properties were changed inside the material dialog
*
* @param _node unused
*/
void slotNodeChanged( ACG::SceneGraph::BaseNode* _node );
/// Hide/Show all light sources if checkbox has been checked
......
......@@ -469,7 +469,7 @@ void TreeModel::objectChanged(int _id) {
/** \brief The object with the given id has been added. add it to the internal tree
*
* @param id_ id of the object
* @param _object The added object
*/
void TreeModel::objectAdded(BaseObject* _object){
......@@ -504,7 +504,7 @@ void TreeModel::objectAdded(BaseObject* _object){
/** \brief The object with the given id has been deleted. delete it from the internal tree
*
* @param id_ id of the object
* @param _id id of the object
*/
void TreeModel::objectDeleted(int _id){
......@@ -576,7 +576,7 @@ TreeItem* TreeModel::getItem(const QModelIndex &index) const
/** \brief Return item-name at given index
*
* @param index a ModelIndex
* @param index A ModelIndex
* @return name of the item at given index
*/
QString TreeModel::itemName(const QModelIndex &index) const
......@@ -632,7 +632,9 @@ QModelIndex TreeModel::getModelIndex(TreeItem* _object, int _column ){
/** \brief Recursively update a column up to the root of the tree
*
* @param _item item to start with
* @param _item item to start with
* @param _column Column that should be propagated
* @param _value New value
*/
void TreeModel::propagateUpwards(TreeItem* _item, int _column, bool _value ){
......@@ -661,7 +663,8 @@ void TreeModel::propagateUpwards(TreeItem* _item, int _column, bool _value ){
/** \brief Recursively update a column up to the root of the tree
*
* @param _item item to start with
* @param _item Item to start with
* @param _column Column that should be propagated
*/
void TreeModel::propagateDownwards(TreeItem* _item, int _column ){
......@@ -716,13 +719,6 @@ void TreeModel::propagateDownwards(TreeItem* _item, int _column ){
//******************************************************************************
/** \brief Set Data at 'index' to 'value'
*
* @param index a ModelIndex defining the positin in the model
* @param value the new value
* @param unused
* @return return if the data was set successfully
*/
bool TreeModel::setData(const QModelIndex &index, const QVariant &value, int /*role*/)
{
......
......@@ -102,7 +102,13 @@ public:
*/
int columnCount(const QModelIndex &_parent = QModelIndex()) const;
/// Set the data at the given index
/** \brief Set Data at 'index' to 'value'
*
* @param index a ModelIndex defining the positin in the model
* @param value the new value
* @param role unused
* @return return if the data was set successfully
*/
bool setData(const QModelIndex &index, const QVariant &value , int role);
/** @} */
......@@ -146,7 +152,7 @@ public:
void moveItem(TreeItem* _item, TreeItem* _parent );
private:
/// Rootitem of the tree
/// Root item of the tree
TreeItem* rootItem_;
......@@ -171,7 +177,15 @@ public:
/// get the mimeData for a given ModelIndex
QMimeData* mimeData(const QModelIndexList& indexes) const;
/// Called when mimeData is dropped somewhere
/** \brief This is called when mimeData is dropped
*
* @param data The dropped data
* @param action The definition of the dropAction which occurred
* @param row Unused
* @param column Unused
* @param parent Parent under which the drop occurred
* @return returns if the drop was successful
*/
bool dropMimeData(const QMimeData *data,
Qt::DropAction action, int row, int column, const QModelIndex &parent);
......
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