forked from qt-creator/qt-creator
Documentation: Code assist API
Change-Id: Id703725708823edc24171f7c1b28befe99032d63 Reviewed-on: http://codereview.qt.nokia.com/154 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@nokia.com>
This commit is contained in:
committed by
Friedemann Kleint
parent
5647e67762
commit
8e84872ace
@@ -35,8 +35,9 @@
|
||||
using namespace TextEditor;
|
||||
|
||||
/*!
|
||||
\class IAssistProvider
|
||||
\brief The IAssistProvider is an interface for providing code assist.
|
||||
\class TextEditor::IAssistProvider
|
||||
\brief The IAssistProvider class acts as an interface for providing code assist.
|
||||
\ingroup CodeAssist
|
||||
|
||||
There might be different kinds of assist such as completions or refactoring
|
||||
actions (quickfixes).
|
||||
@@ -46,6 +47,8 @@ using namespace TextEditor;
|
||||
Examples of completions currently supported are snippets, function hints, and
|
||||
contextual contents.
|
||||
|
||||
This is class is part of the CodeAssist API.
|
||||
|
||||
\sa IAssistProposal, IAssistProcessor
|
||||
*/
|
||||
|
||||
@@ -56,13 +59,13 @@ IAssistProvider::~IAssistProvider()
|
||||
{}
|
||||
|
||||
/*!
|
||||
\fn bool 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.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn IAssistProcessor *createProcessor() const
|
||||
\fn IAssistProcessor *TextEditor::IAssistProvider::createProcessor() const
|
||||
|
||||
Creates and returns the IAssistProcessor responsible for computing an IAssistProposal.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user