summaryrefslogtreecommitdiff
path: root/src/plugins/cpptools/cpppreprocessor.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/plugins/cpptools/cpppreprocessor.cpp')
-rw-r--r--src/plugins/cpptools/cpppreprocessor.cpp12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/plugins/cpptools/cpppreprocessor.cpp b/src/plugins/cpptools/cpppreprocessor.cpp
index 5c5d1bd803..d12b56b207 100644
--- a/src/plugins/cpptools/cpppreprocessor.cpp
+++ b/src/plugins/cpptools/cpppreprocessor.cpp
@@ -5,6 +5,18 @@
#include <QCoreApplication>
+/*!
+ * \class CppTools::Internal::CppPreprocessor
+ * \brief The CppPreprocessor class updates set of indexed C++ files.
+ *
+ * Indexed file is truncated version of fully parsed document: copy of source
+ * code and full AST will be dropped when indexing is done. Working copy ensures
+ * that documents with most recent copy placed in memory will be parsed correctly.
+ *
+ * \sa CPlusPlus::Document
+ * \sa CppTools::CppModelManagerInterface::WorkingCopy
+ */
+
using namespace CPlusPlus;
using namespace CppTools;
using namespace CppTools::Internal;