feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Editors: Add at least some short documentation.

Browse Source 
Change-Id: I7fc7946405d3cbb1af0cf29a9d328d857eb8304a
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
Eike Ziller
2014-01-21 14:22:33 +01:00
parent 2678662fb4
commit 5deb0f367e
6 changed files with 63 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/plugins/coreplugin/idocument.cpp
View File

@@ -34,6 +34,22 @@
#include <QFile>
#include <QFileInfo>
/*!
\class Core::IDocument
\brief The IDocument class describes a document that can be saved and reloaded.
The most common use for implementing an IDocument subclass, is as a document for an IEditor
implementation. Multiple editors can work in the same document instance, so the IDocument
subclass should hold all data and functions that are independent from the specific
IEditor instance, for example the content, highlighting information, the name of the
corresponding file, and functions for saving and reloading the file.
Each IDocument subclass works only with the corresponding IEditor subclasses that it
was designed to work with.
\mainclass
*/
/*!
\fn QString Core::IDocument::filePath() const
Returns the absolute path of the file that this document refers to. May be empty for