add some documentation

This commit is contained in:
Duncan Mac-Vicar P 2011-03-20 22:17:23 +01:00
parent ad90a6c05e
commit 3bb5869183

View file

@ -11,22 +11,34 @@ class INotify;
namespace Mirall {
/**
* Watches a folder and sub folders for changes
*/
class FolderWatcher : public QObject
{
Q_OBJECT
public:
/**
* @param root Path of the root of the folder
*/
FolderWatcher(const QString &root, QObject *parent = 0L);
~FolderWatcher();
/**
* All watched folders and subfolders
*/
QStringList folders() const;
signals:
/**
* Emitted when one of the paths is changed
*/
void folderChanged(const QString &path);
protected slots:
void slotINotifyEvent(int mask, int cookie, const QString &path);
void slotAddFolderRecursive(const QString &path);
private:
QMutex _mutex;
INotify *_inotify;
QString _root;