Commit c5c50166 authored by Leena Miettinen's avatar Leena Miettinen
Browse files

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: default avatarDavid Schulz <david.schulz@digia.com>
Reviewed-by: default avatarNikolai Kosjar <nikolai.kosjar@digia.com>
parent 94274c1f
......@@ -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)
......
......@@ -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.
*/
/*!
......
......@@ -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()
{
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment