summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLeandro Melo <leandro.melo@nokia.com>2011-05-27 14:30:17 +0200
committerLeena Miettinen <riitta-leena.miettinen@nokia.com>2011-05-27 15:25:54 +0200
commit2fd5057604ea1e29df73dee5181153fe6cd3fe68 (patch)
tree0cf37e42d51d0aa38f45c6243800ea74224ee2b9 /doc
parent2e9931f9ae95061842681f479fc01e8730fb94b7 (diff)
downloadqt-creator-2fd5057604ea1e29df73dee5181153fe6cd3fe68.tar.gz
Documentation: Snippets support
Change-Id: I40dd20a7da93ab7af3044d9bebf49e15dbfb7aa4 Reviewed-on: http://codereview.qt.nokia.com/184 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@nokia.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/external-tool-spec.qdoc1
-rw-r--r--doc/api/qtcreator-api.qdoc4
-rw-r--r--doc/api/qtcreator-code-snippet-config.qdoc41
-rw-r--r--doc/api/qtcreator-dev.qdoc13
4 files changed, 9 insertions, 50 deletions
diff --git a/doc/api/external-tool-spec.qdoc b/doc/api/external-tool-spec.qdoc
index f036a43b81..8e6362a9a9 100644
--- a/doc/api/external-tool-spec.qdoc
+++ b/doc/api/external-tool-spec.qdoc
@@ -21,7 +21,6 @@
/*!
\contentspage{index.html}{Qt Creator}
- \previouspage qtcreator-code-snippet-config.html
\page external-tool-spec.html
\nextpage coding-style.html
diff --git a/doc/api/qtcreator-api.qdoc b/doc/api/qtcreator-api.qdoc
index 707c653b82..b2bbb68b87 100644
--- a/doc/api/qtcreator-api.qdoc
+++ b/doc/api/qtcreator-api.qdoc
@@ -115,8 +115,8 @@
\o \l{TextEditor}
\o This is where everything starts if you want to create a text editor. Besides
the base editor itself, this plugin contains APIs for supporting functionality
- like snippets, highlighting, \l{CodeAssist}{code assist}, indentation and style,
- and others.
+ like \l{Snippets}{snippets}, highlighting, \l{CodeAssist}{code assist}, indentation
+ and style, and others.
\endtable
*/
diff --git a/doc/api/qtcreator-code-snippet-config.qdoc b/doc/api/qtcreator-code-snippet-config.qdoc
deleted file mode 100644
index cbd110acfd..0000000000
--- a/doc/api/qtcreator-code-snippet-config.qdoc
+++ /dev/null
@@ -1,41 +0,0 @@
-/****************************************************************************
-**
-** This file is part of Qt Creator
-**
-** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
-**
-** Contact: Nokia Corporation (info@qt.nokia.com)
-**
-**
-** GNU Free Documentation License
-**
-** Alternatively, this file may be used under the terms of the GNU Free
-** Documentation License version 1.3 as published by the Free Software
-** Foundation and appearing in the file included in the packaging of this
-** file.
-**
-** If you have questions regarding the use of this file, please contact
-** Nokia at qt-info@nokia.com.
-**
-****************************************************************************/
-
-/*!
- \previouspage
- \page qtcreator-code-snippet-config.html
- \title Code Snippet Configuration Files
- \nextpage
-
- You can use code snippet configuration files to <add the purpose of the
- files>.
-
- Name the configuration files as follows:
-
- Copy the configuration files to the following directory:
-
-
-
- \section1 File Syntax
-
-
-
-*/
diff --git a/doc/api/qtcreator-dev.qdoc b/doc/api/qtcreator-dev.qdoc
index 9fafb633a7..864dfd9104 100644
--- a/doc/api/qtcreator-dev.qdoc
+++ b/doc/api/qtcreator-dev.qdoc
@@ -45,19 +45,21 @@
whole files or classes spread over multiple files, or complete projects,
you can create code snippets, templates, and wizards for that purpose.
- \section2 Code Snippets
+ \section2 Snippets
- Typically, code snippets consist of a few lines of code that you regularly
+ Typically, snippets consist of a few lines of code (although they
+ can also be plain text) that you regularly
want to insert into a bigger body of code, but do not want to type each
time. For example, \c while and \c for loops, \c if-else and \c try-catch
constructs, and class skeletons. Snippets are triggered in the same way as
- normal code completion. Qt Creator contains a set of preconfigured snippets
+ normal code completion (see \l{Code Assist}{Providing Code Assist}).
+ Qt Creator contains a set of preconfigured snippets groups
to which you can add your own snippets.
\list
\o \l{http://doc.qt.nokia.com/qtcreator/creator-completing-code.html#editing-code-snippets}
- {Adding Code Snippets in Qt Creator}
- \o \l{Code Snippet Configuration Files}
+ {Snippets User Interface}
+ \o \l{Snippets} {Adding Snippets Groups}
\endlist
\section2 File, Class and Project Templates
@@ -239,7 +241,6 @@
\endlist
\o Reference
\list
- \o \l{Code Snippet Configuration Files}
\o \l{http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-latest.html}
{MIME Type Specification Files}
\o \l{External Tool Specification Files}