From c5c501669fad9adce4a7628847ed352a1c098038 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 10 Sep 2013 12:52:35 +0200 Subject: [PATCH] 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 Reviewed-by: Nikolai Kosjar --- src/plugins/texteditor/basetextdocument.cpp | 8 ++++---- src/plugins/texteditor/codeassist/iassistprovider.cpp | 2 +- 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 0390a07493d..21a4e2ead1a 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 cf7bc5a416e..14a0f581ec7 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 de9c5acd092..90a32633189 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() {