QmlJS: Improve ModelManagerInterface API, add docs.

Change-Id: Ic65d767cbad85de89dffaac66d9e80d8d467f04a
Reviewed-on: http://codereview.qt.nokia.com/3851
Reviewed-by: Leandro T. C. Melo <leandro.melo@nokia.com>

1 files changed, 18 insertions, 0 deletions

diff --git a/src/libs/qmljs/qmljsmodelmanagerinterface.cpp b/src/libs/qmljs/qmljsmodelmanagerinterface.cpp
index fb43abc65a..96aac5619d 100644
--- a/src/libs/qmljs/qmljsmodelmanagerinterface.cpp
+++ b/src/libs/qmljs/qmljsmodelmanagerinterface.cpp
@@ -34,6 +34,24 @@
 
 using namespace QmlJS;
 
+/*!
+    \class QmlJS::ModelManagerInterface
+    \brief Interface to the global state of the QmlJS code model.
+    \sa QmlJS::Document QmlJS::Snapshot QmlJSTools::Internal::ModelManager
+
+    The ModelManagerInterface is an interface for global state and actions in
+    the QmlJS code model. It is implemented by \l{QmlJSTools::Internal::ModelManager}
+    and the instance can be accessed through ModelManagerInterface::instance().
+
+    One of its primary concerns is to keep the Snapshots it
+    maintains up to date by parsing documents and finding QML modules.
+
+    It has a Snapshot that contains only valid Documents,
+    accessible through ModelManagerInterface::snapshot() and a Snapshot with
+    potentially more recent, but invalid documents that is exposed through
+    ModelManagerInterface::newestSnapshot().
+*/
+
 static ModelManagerInterface *g_instance = 0;
 
 ModelManagerInterface::ModelManagerInterface(QObject *parent)