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:
Leandro Melo
2011-05-26 18:09:17 +02:00
committed by Friedemann Kleint
parent 5647e67762
commit 8e84872ace
10 changed files with 103 additions and 47 deletions

View File

@@ -35,8 +35,10 @@
using namespace TextEditor;
/*!
\class IAssistProcessor
\brief The IAssistProcessor is an interface that actually computes an assist proposal.
\class TextEditor::IAssistProcessor
\brief The IAssistProcessor class acts as an interface that actually computes an assist
proposal.
\ingroup CodeAssist
\sa IAssistProposal, IAssistProvider
*/
@@ -48,7 +50,7 @@ IAssistProcessor::~IAssistProcessor()
{}
/*!
\fn IAssistProposal *perform(const IAssistInterface *interface)
\fn IAssistProposal *TextEditor::IAssistProcessor::perform(const IAssistInterface *interface)
Computes a proposal and returns it. Access to the document is made through the \a interface.
If this is an asynchronous processor the \a interface will be detached.