From 2e9931f9ae95061842681f479fc01e8730fb94b7 Mon Sep 17 00:00:00 2001 From: Leandro Melo Date: Fri, 27 May 2011 10:58:26 +0200 Subject: [PATCH] Documentation: More on code assist Change-Id: Icd4edd9fbd2067e46b1c8933d8e9139dafba3e67 Reviewed-on: http://codereview.qt.nokia.com/183 Reviewed-by: Leena Miettinen --- doc/api/qtcreator-dev.qdoc | 1 + src/plugins/texteditor/codeassist/iassistproposal.cpp | 10 +++++++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/api/qtcreator-dev.qdoc b/doc/api/qtcreator-dev.qdoc index 1a14b855a61..9fafb633a71 100644 --- a/doc/api/qtcreator-dev.qdoc +++ b/doc/api/qtcreator-dev.qdoc @@ -130,6 +130,7 @@ \o \l{Creating Plugins} \o \l{Qt Creator Coding Rules} \o \l{Text Editors} + \o \l{CodeAssist} {Providing Code Assist} \endlist \section2 Other Custom Editors diff --git a/src/plugins/texteditor/codeassist/iassistproposal.cpp b/src/plugins/texteditor/codeassist/iassistproposal.cpp index e082f6c762f..4eaa89dc6d6 100644 --- a/src/plugins/texteditor/codeassist/iassistproposal.cpp +++ b/src/plugins/texteditor/codeassist/iassistproposal.cpp @@ -38,12 +38,16 @@ using namespace TextEditor; \group CodeAssist \title Code Assist for Editors - These classes are used to provide code assist support such as completions and refactoring - actions for editors. + Code assist is available in the form of completions and refactoring actions pop-ups + which are triggered under particular circumstances. This group contains the classes + used to provide such support. Completions can be of a variety of kind like function hints, snippets, and regular context-aware content. The later are usually represented by semantic proposals, but - it is also possible that they are simply plain text as supported in the fake vim mode. + it is also possible that they are simply plain text like in the fake vim mode. + + Completions also have the possibility to run asynchronously in a separate thread and + then not blocking the GUI. This is the default behavior. */ /*!