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

Doc: edit texteditor plugin API docs

Browse Source 
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>
This commit is contained in:
Leena Miettinen
2013-09-10 12:52:35 +02:00
parent 94274c1f57
commit c5c501669f
3 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/plugins/texteditor/basetextdocument.cpp
View File

@@ -208,10 +208,10 @@ ITextMarkable *BaseTextDocument::documentMarker() const
} }
/*! /*!
* \brief Saves the document to the specified file. * Saves the document to the file specified by \a fileName. If errors occur,
* \param errorString output parameter, contains error reason. * \a errorString contains their cause.
* \param autoSave signalise that this function was called by the automatic save routine. * \a autoSave returns whether this function was called by the automatic save routine.
* If autosave is true, the cursor will be restored and some signals suppressed * 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()). * and we do not clean up the text file (cleanWhitespace(), ensureFinalNewLine()).
*/ */
bool BaseTextDocument::save(QString *errorString, const QString &fileName, bool autoSave) bool BaseTextDocument::save(QString *errorString, const QString &fileName, bool autoSave)

2
src/plugins/texteditor/codeassist/iassistprovider.cpp
View File

@@ -52,7 +52,7 @@ using namespace TextEditor;
/*! /*!
\fn bool TextEditor::IAssistProvider::supportsEditor(const QString &editorId) const \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.
*/ */
/*! /*!

4
src/plugins/texteditor/syntaxhighlighter.cpp
View File

@@ -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 QTextDocument. The specified QTextEdit also becomes the owner of
the SyntaxHighlighter. 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() SyntaxHighlighter::~SyntaxHighlighter()
{ {