doc

3 files changed, 39 insertions, 5 deletions

diff --git a/src/imports/folderlistmodel/plugin.cpp b/src/imports/folderlistmodel/plugin.cpp
index b94efb0..d4569f7 100644
--- a/src/imports/folderlistmodel/plugin.cpp
+++ b/src/imports/folderlistmodel/plugin.cpp
@@ -46,6 +46,7 @@
 
 QT_BEGIN_NAMESPACE
 
+//![class decl]
 class QmlFolderListModelPlugin : public QDeclarativeExtensionPlugin
 {
     Q_OBJECT
@@ -56,10 +57,13 @@ public:
         qmlRegisterType<QDeclarativeFolderListModel>(uri,1,0,"FolderListModel");
     }
 };
+//![class decl]
 
 QT_END_NAMESPACE
 
 #include "plugin.moc"
 
+//![plugin export decl]
 Q_EXPORT_PLUGIN2(qmlfolderlistmodelplugin, QT_PREPEND_NAMESPACE(QmlFolderListModelPlugin));
+//![plugin export decl]
 
diff --git a/src/imports/folderlistmodel/qdeclarativefolderlistmodel.cpp b/src/imports/folderlistmodel/qdeclarativefolderlistmodel.cpp
index a16f0c6..0a75edf 100644
--- a/src/imports/folderlistmodel/qdeclarativefolderlistmodel.cpp
+++ b/src/imports/folderlistmodel/qdeclarativefolderlistmodel.cpp
@@ -39,6 +39,7 @@
 **
 ****************************************************************************/
 
+//![code]
 #include "qdeclarativefolderlistmodel.h"
 #include <QDirModel>
 #include <QDebug>
@@ -99,6 +100,12 @@ public:
     separator, Qt will translate your paths to conform to the underlying
     operating system.
 
+    This type is made available by importing the \c Qt.labs.folderlistmodel module.
+    \e {Elements in the Qt.labs module are not guaranteed to remain compatible
+    in future versions.}
+
+    \bold{import Qt.labs.folderlistmodel 1.0}
+
     The roles available are:
     \list
     \o fileName
@@ -387,3 +394,5 @@ void QDeclarativeFolderListModel::setShowOnlyReadable(bool on)
     else
         d->model.setFilter(d->model.filter() & ~QDir::Readable);
 }
+
+//![code]
diff --git a/src/imports/folderlistmodel/qdeclarativefolderlistmodel.h b/src/imports/folderlistmodel/qdeclarativefolderlistmodel.h
index e610a14..87141c5 100644
--- a/src/imports/folderlistmodel/qdeclarativefolderlistmodel.h
+++ b/src/imports/folderlistmodel/qdeclarativefolderlistmodel.h
@@ -51,11 +51,15 @@ class QDeclarativeContext;
 class QModelIndex;
 
 class QDeclarativeFolderListModelPrivate;
+
+//![class begin]
 class QDeclarativeFolderListModel : public QAbstractListModel, public QDeclarativeParserStatus
 {
     Q_OBJECT
     Q_INTERFACES(QDeclarativeParserStatus)
+//![class begin]
 
+//![class props]
     Q_PROPERTY(QUrl folder READ folder WRITE setFolder NOTIFY folderChanged)
     Q_PROPERTY(QUrl parentFolder READ parentFolder NOTIFY folderChanged)
     Q_PROPERTY(QStringList nameFilters READ nameFilters WRITE setNameFilters)
@@ -65,7 +69,9 @@ class QDeclarativeFolderListModel : public QAbstractListModel, public QDeclarati
     Q_PROPERTY(bool showDotAndDotDot READ showDotAndDotDot WRITE setShowDotAndDotDot)
     Q_PROPERTY(bool showOnlyReadable READ showOnlyReadable WRITE setShowOnlyReadable)
     Q_PROPERTY(int count READ count)
+//![class props]
 
+//![abslistmodel]
 public:
     QDeclarativeFolderListModel(QObject *parent = 0);
     ~QDeclarativeFolderListModel();
@@ -74,9 +80,13 @@ public:
 
     int rowCount(const QModelIndex &parent) const;
     QVariant data(const QModelIndex &index, int role) const;
+//![abslistmodel]
 
+//![count]
     int count() const { return rowCount(QModelIndex()); }
+//![count]
 
+//![prop funcs]
     QUrl folder() const;
     void setFolder(const QUrl &folder);
 
@@ -85,11 +95,6 @@ public:
     QStringList nameFilters() const;
     void setNameFilters(const QStringList &filters);
 
-    virtual void classBegin();
-    virtual void componentComplete();
-
-    Q_INVOKABLE bool isFolder(int index) const;
-
     enum SortField { Unsorted, Name, Time, Size, Type };
     SortField sortField() const;
     void setSortField(SortField field);
@@ -104,10 +109,23 @@ public:
     void  setShowDotAndDotDot(bool);
     bool showOnlyReadable() const;
     void  setShowOnlyReadable(bool);
+//![prop funcs]
+
+//![isfolder]
+    Q_INVOKABLE bool isFolder(int index) const;
+//![isfolder]
+
+//![parserstatus]
+    virtual void classBegin();
+    virtual void componentComplete();
+//![parserstatus]
 
+//![notifier]
 Q_SIGNALS:
     void folderChanged();
+//![notifier]
 
+//![class end]
 private Q_SLOTS:
     void refresh();
     void inserted(const QModelIndex &index, int start, int end);
@@ -118,7 +136,10 @@ private:
     Q_DISABLE_COPY(QDeclarativeFolderListModel)
     QDeclarativeFolderListModelPrivate *d;
 };
+//![class end]
 
+//![qml decl]
 QML_DECLARE_TYPE(QDeclarativeFolderListModel)
+//![qml decl]
 
 #endif // QDECLARATIVEFOLDERLISTMODEL_H