diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-05 14:29:24 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-20 11:22:47 +0200 |
| commit | 41411165bac561d3cd93a793c6ae76dcb2937e12 (patch) | |
| tree | cc9e5e516899407448ad8eadd207909ee3115493 /src/libs/qmljs/qmljsdocument.cpp | |
| parent | 440725322abf0189c0cb28baddebe76bc26c5f05 (diff) | |
| download | qt-creator-41411165bac561d3cd93a793c6ae76dcb2937e12.tar.gz | |
Doc: use standard wording in \brief commands
QDoc does some magic with the \class and \namespaces
and \brief commands, so the following wording must be used:
"The xxx class yyy ..."
Change-Id: Id231f30e8464898b776888d5423523de404aae34
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
Diffstat (limited to 'src/libs/qmljs/qmljsdocument.cpp')
| -rw-r--r-- | src/libs/qmljs/qmljsdocument.cpp | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/src/libs/qmljs/qmljsdocument.cpp b/src/libs/qmljs/qmljsdocument.cpp index a7eb00c354..b75a74aae9 100644 --- a/src/libs/qmljs/qmljsdocument.cpp +++ b/src/libs/qmljs/qmljsdocument.cpp @@ -39,7 +39,7 @@ using namespace QmlJS::AST; /*! \class QmlJS::Document - \brief A Qml or JavaScript document. + \brief The Document class creates a QML or JavaScript document. \sa Snapshot Documents are usually created by the ModelManagerInterface @@ -57,7 +57,7 @@ using namespace QmlJS::AST; /*! \class QmlJS::LibraryInfo - \brief A Qml library. + \brief The LibraryInfo class creates a QML library. \sa Snapshot A LibraryInfo is created when the ModelManagerInterface finds @@ -71,11 +71,10 @@ using namespace QmlJS::AST; /*! \class QmlJS::Snapshot - \brief A set of Document::Ptr and LibraryInfo instances. + \brief The Snapshot class holds and offers access to a set of + Document::Ptr and LibraryInfo instances. \sa Document LibraryInfo - A Snapshot holds and offers access to a set of Document and LibraryInfo instances. - Usually Snapshots are copies of the snapshot maintained and updated by the ModelManagerInterface that updates its instance as parsing threads finish and new information becomes available. |