diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-10 12:52:35 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-11 10:01:42 +0200 |
| commit | c5c501669fad9adce4a7628847ed352a1c098038 (patch) | |
| tree | 50ad8b320cc1b91e8e1656500ea136eedc29f89d | |
| parent | 94274c1f5797cc658c33d116b33926ee8bc5e6e6 (diff) | |
| download | qt-creator-c5c501669fad9adce4a7628847ed352a1c098038.tar.gz | |
Doc: edit texteditor plugin API docs
Fix grammar and style issues and punctuation.
Use the \a command instead of \param (not a QDoc command).
Change-Id: Ib048f0219a2c857e5fc3fcd858afbcbd58819193
Reviewed-by: David Schulz <david.schulz@digia.com>
Reviewed-by: Nikolai Kosjar <nikolai.kosjar@digia.com>
| -rw-r--r-- | src/plugins/texteditor/basetextdocument.cpp | 8 | ||||
| -rw-r--r-- | src/plugins/texteditor/codeassist/iassistprovider.cpp | 2 | ||||
| -rw-r--r-- | src/plugins/texteditor/syntaxhighlighter.cpp | 4 |
3 files changed, 7 insertions, 7 deletions
diff --git a/src/plugins/texteditor/basetextdocument.cpp b/src/plugins/texteditor/basetextdocument.cpp index 0390a07493..21a4e2ead1 100644 --- a/src/plugins/texteditor/basetextdocument.cpp +++ b/src/plugins/texteditor/basetextdocument.cpp @@ -208,10 +208,10 @@ ITextMarkable *BaseTextDocument::documentMarker() const } /*! - * \brief Saves the document to the specified file. - * \param errorString output parameter, contains error reason. - * \param autoSave signalise that this function was called by the automatic save routine. - * If autosave is true, the cursor will be restored and some signals suppressed + * Saves the document to the file specified by \a fileName. If errors occur, + * \a errorString contains their cause. + * \a autoSave returns whether this function was called by the automatic save routine. + * If \a autoSave is true, the cursor will be restored and some signals suppressed * and we do not clean up the text file (cleanWhitespace(), ensureFinalNewLine()). */ bool BaseTextDocument::save(QString *errorString, const QString &fileName, bool autoSave) diff --git a/src/plugins/texteditor/codeassist/iassistprovider.cpp b/src/plugins/texteditor/codeassist/iassistprovider.cpp index cf7bc5a416..14a0f581ec 100644 --- a/src/plugins/texteditor/codeassist/iassistprovider.cpp +++ b/src/plugins/texteditor/codeassist/iassistprovider.cpp @@ -52,7 +52,7 @@ using namespace TextEditor; /*! \fn bool TextEditor::IAssistProvider::supportsEditor(const QString &editorId) const - Returns whether this provider supports the editor which has the give \a editorId. + Returns whether this provider supports the editor which has the \a editorId. */ /*! diff --git a/src/plugins/texteditor/syntaxhighlighter.cpp b/src/plugins/texteditor/syntaxhighlighter.cpp index de9c5acd09..90a3263318 100644 --- a/src/plugins/texteditor/syntaxhighlighter.cpp +++ b/src/plugins/texteditor/syntaxhighlighter.cpp @@ -335,7 +335,7 @@ SyntaxHighlighter::SyntaxHighlighter(BaseTextDocument *parent) } /*! - Constructs a SyntaxHighlighter and installs it on \a parent 's + Constructs a SyntaxHighlighter and installs it on \a parent's QTextDocument. The specified QTextEdit also becomes the owner of the SyntaxHighlighter. */ @@ -347,7 +347,7 @@ SyntaxHighlighter::SyntaxHighlighter(QTextEdit *parent) } /*! - Destructor. Uninstalls this syntax highlighter from the text document. + Destructor that uninstalls this syntax highlighter from the text document. */ SyntaxHighlighter::~SyntaxHighlighter() { |