cleaned some code in the tals; added doxygen comments

git-svn-id: https://svn.kvirc.de/svn/trunk/kvirc@2759 17fca916-40b9-46aa-a4ea-0a15b648b75c

3 files changed, 76 insertions, 23 deletions

diff --git a/src/kvilib/tal/kvi_tal_listwidget.h b/src/kvilib/tal/kvi_tal_listwidget.h
index 6eb6c5f93..2f5216373 100644
--- a/src/kvilib/tal/kvi_tal_listwidget.h
+++ b/src/kvilib/tal/kvi_tal_listwidget.h
@@ -69,7 +69,6 @@ class KVILIB_API KviTalListWidgetText : public KviTalListWidgetItem
 public:
 	KviTalListWidgetText(KviTalListWidget* listbox, const QString & text=QString());
 	KviTalListWidgetText(const QString & text=QString());
-// 	KviTalListWidgetText(KviTalListWidget* listbox, const QString & text, KviTalListWidgetItem *after);
 	~KviTalListWidgetText();
 	
 	int height(const KviTalListWidget *) const;
@@ -91,10 +90,8 @@ class KVILIB_API KviTalListWidgetPixmap : public KviTalListWidgetItem
 public:
 	KviTalListWidgetPixmap(KviTalListWidget* listbox, const QPixmap &);
 	KviTalListWidgetPixmap(const QPixmap &);
-// 	KviTalListWidgetPixmap(KviTalListWidget* listbox, const QPixmap & pix, KviTalListWidgetItem *after);
 	KviTalListWidgetPixmap(KviTalListWidget* listbox, const QPixmap &, const QString&);
 	KviTalListWidgetPixmap(const QPixmap &, const QString&);
-// 	KviTalListWidgetPixmap(KviTalListWidget* listbox, const QPixmap & pix, const QString&, KviTalListWidgetItem *after);
 	~KviTalListWidgetPixmap();
 	
 	const QPixmap *pixmap() const { return ± }
diff --git a/src/kvilib/tal/kvi_tal_treewidget.h b/src/kvilib/tal/kvi_tal_treewidget.h
index 3f6d8636e..d2fd45bbe 100644
--- a/src/kvilib/tal/kvi_tal_treewidget.h
+++ b/src/kvilib/tal/kvi_tal_treewidget.h
@@ -25,24 +25,48 @@
 //
 //=============================================================================
 
+/**
+* \file kvi_tal_treewidget.h
+* \author Szymon Stefanek
+* \brief Toolkit Abstraction Layer class
+*/
+
 #include "kvi_settings.h"
-#include "kvi_qstring.h"
 
 #include <QTreeWidget>
-#include <QHeaderView>
 
 class KviTalTreeWidgetItem;
 
+/**
+* \class KviTalTreeWidget
+* \brief Toolkit Abstraction Layer: TreeWidget class
+*/
 
 class KVILIB_API KviTalTreeWidget : public QTreeWidget
 {
 	friend class KviTalTreeWidgetItem;
 	Q_OBJECT
 public:
+	/**
+	* \brief Constructs the treewidget object
+	* \param pParent The parent object
+	* \return KviTalTreeWidget
+	*/
 	KviTalTreeWidget(QWidget * pParent);
+
+	/**
+	* \brief Destroys the treewidget object
+	* \return KviTalTreeWidget
+	*/
 	virtual ~KviTalTreeWidget() {};
 public:
-	inline KviTalTreeWidgetItem* topLevelItem(int i) { return (KviTalTreeWidgetItem*) QTreeWidget::topLevelItem(i); }
+
+	/**
+	* \brief Returns the top level item at index iIndex
+	* \param iIndex Index of the wanted top level item
+	* \return KviTalTreeWidgetItem*
+	*/
+	inline KviTalTreeWidgetItem* topLevelItem(int iIndex) { return (KviTalTreeWidgetItem*) QTreeWidget::topLevelItem(iIndex); }
 signals:
 	void currentItemChanged(KviTalTreeWidgetItem *,KviTalTreeWidgetItem *);
 	void selectionChanged();
@@ -74,26 +98,57 @@ protected slots:
 class KVILIB_API KviTalTreeWidgetItem : public QTreeWidgetItem
 {
 public:
-	KviTalTreeWidgetItem()
-	: QTreeWidgetItem() {};
-	KviTalTreeWidgetItem(KviTalTreeWidget * pParent)
-	: QTreeWidgetItem(pParent) {};
-	KviTalTreeWidgetItem(KviTalTreeWidgetItem * pParent)
-	: QTreeWidgetItem(pParent) {};
-	KviTalTreeWidgetItem(KviTalTreeWidget * pParent, KviTalTreeWidgetItem * preceding)
-	: QTreeWidgetItem(pParent, preceding) {};
-	KviTalTreeWidgetItem(KviTalTreeWidgetItem * pParent, KviTalTreeWidgetItem * preceding)
-	: QTreeWidgetItem(pParent, preceding) {};
+	/**
+	* \brief Constructs a treewidgetitem object without a parent
+	* \return KviTalTreeWidgetItem
+	*/
+	KviTalTreeWidgetItem(): QTreeWidgetItem() {};
+
+	/**
+	* \brief Constructs a top-level treewidgetitem object
+	* \param pParent The parent TreeWidget
+	* \return KviTalTreeWidgetItem
+	*/
+	KviTalTreeWidgetItem(KviTalTreeWidget * pParent): QTreeWidgetItem(pParent) {};
+
+	/**
+	* \brief Constructs a child treewidgetitem object
+	* \param pParent The parent TreeWidgetItem
+	* \return KviTalTreeWidgetItem
+	*/
+	KviTalTreeWidgetItem(KviTalTreeWidgetItem * pParent): QTreeWidgetItem(pParent) {};
 
+	/**
+	* \brief Constructs a top-level treewidgetitem object, inserting it after an existing treewidgetitem
+	* \param pParent The parent TreeWidget
+	* \param pPreceding The already existing TreeWidgetItem you want the new item to be placed after.
+	* \return KviTalTreeWidgetItem
+	*/
+	KviTalTreeWidgetItem(KviTalTreeWidget * pParent, KviTalTreeWidgetItem * pPreceding): QTreeWidgetItem(pParent, pPreceding) {};
+
+	/**
+	* \brief Destroys the treewidgetitem object
+	* \return KviTalTreeWidgetItem
+	*/
 	virtual ~KviTalTreeWidgetItem() {};
-	int compare ( KviTalTreeWidgetItem * i, int col, bool ascending ) const
-	{
-		QString key=text(col);
-		return key.localeAwareCompare(i->text(col));
-	};
+
+	/**
+	* \brief Returns the Treewidget that contains the item
+	* \return KviTalTreeWidget
+	*/
 	inline KviTalTreeWidget* treeWidget() { return (KviTalTreeWidget*) QTreeWidgetItem::treeWidget(); };
+
+	/**
+	* \brief Returns the parent TreewidgetItem
+	* \return KviTalTreeWidgetItem
+	*/
 	inline KviTalTreeWidgetItem* parent() { return (KviTalTreeWidgetItem*) QTreeWidgetItem::parent(); }
-	inline KviTalTreeWidgetItem* child(int i) { return (KviTalTreeWidgetItem*) QTreeWidgetItem::child(i); }
+
+	/**
+	* \brief Returns the child TreewidgetItem at index iIndex
+	* \return KviTalTreeWidgetItem
+	*/
+	inline KviTalTreeWidgetItem* child(int iIndex) { return (KviTalTreeWidgetItem*) QTreeWidgetItem::child(iIndex); }
 };
 
 #endif // _KVI_TAL_TREEWIDGETW_H_
diff --git a/src/kvirc/ui/kvi_maskeditor.cpp b/src/kvirc/ui/kvi_maskeditor.cpp
index c45cd0d51..0d4ccf23a 100644
--- a/src/kvirc/ui/kvi_maskeditor.cpp
+++ b/src/kvirc/ui/kvi_maskeditor.cpp
@@ -58,7 +58,8 @@ int KviMaskItem::compare ( KviTalTreeWidgetItem * i, int col, bool ascending ) c
 		if( ((KviMaskItem*)i)->mask()->uSetAt == m_Mask.uSetAt ) return  0;
 		if( ((KviMaskItem*)i)->mask()->uSetAt < m_Mask.uSetAt )  return  1;
 	}
-	return KviTalTreeWidgetItem::compare(i,col,ascending);
+
+	return text(col).localeAwareCompare(i->text(col));
 }
 
 KviMaskInputDialog::KviMaskInputDialog(const QString &szMask,KviMaskEditor* pEditor,KviChannel * pChannel)