summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/images/qtcreator-analyze-menu.pngbin45111 -> 12118 bytes
-rw-r--r--doc/images/qtcreator-clang-static-analyzer-options.pngbin0 -> 6373 bytes
-rw-r--r--doc/images/qtcreator-clang-static-analyzer.pngbin0 -> 26939 bytes
-rw-r--r--doc/src/analyze/creator-analyze.qdoc6
-rw-r--r--doc/src/analyze/creator-clang-static-analyzer.qdoc77
-rw-r--r--doc/src/analyze/creator-valgrind.qdoc2
-rw-r--r--doc/src/overview/creator-advanced.qdoc2
-rw-r--r--doc/src/qtcreator.qdoc1
8 files changed, 86 insertions, 2 deletions
diff --git a/doc/images/qtcreator-analyze-menu.png b/doc/images/qtcreator-analyze-menu.png
index 9c5035cc0a..71ceb4e8cd 100644
--- a/doc/images/qtcreator-analyze-menu.png
+++ b/doc/images/qtcreator-analyze-menu.png
Binary files differ
diff --git a/doc/images/qtcreator-clang-static-analyzer-options.png b/doc/images/qtcreator-clang-static-analyzer-options.png
new file mode 100644
index 0000000000..89d0d0c622
--- /dev/null
+++ b/doc/images/qtcreator-clang-static-analyzer-options.png
Binary files differ
diff --git a/doc/images/qtcreator-clang-static-analyzer.png b/doc/images/qtcreator-clang-static-analyzer.png
new file mode 100644
index 0000000000..6d6eecbd4c
--- /dev/null
+++ b/doc/images/qtcreator-clang-static-analyzer.png
Binary files differ
diff --git a/doc/src/analyze/creator-analyze.qdoc b/doc/src/analyze/creator-analyze.qdoc
index d0a760c3b2..afaa994fcf 100644
--- a/doc/src/analyze/creator-analyze.qdoc
+++ b/doc/src/analyze/creator-analyze.qdoc
@@ -59,6 +59,12 @@
You can detect problems in memory management by using the Memcheck
tool and find cache misses in the code by using the Callgrind tool.
+ \li \l{Using Clang Static Analyzer}{Clang Static Analyzer}
+
+ In \QC Enterprise, you can detect problems in C, C++, and
+ Objective-C programs by using the experimental plugin that
+ integrates the Clang Static Analyzer source code analysis tool.
+
\endlist
*/
diff --git a/doc/src/analyze/creator-clang-static-analyzer.qdoc b/doc/src/analyze/creator-clang-static-analyzer.qdoc
new file mode 100644
index 0000000000..0a3d4fe0ff
--- /dev/null
+++ b/doc/src/analyze/creator-clang-static-analyzer.qdoc
@@ -0,0 +1,77 @@
+
+/****************************************************************************
+**
+** Copyright (c) 2014 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of Qt Creator
+**
+**
+** 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.
+**
+**
+****************************************************************************/
+
+// **********************************************************************
+// NOTE: the sections are not ordered by their logical order to avoid
+// reshuffling the file each time the index order changes (i.e., often).
+// Run the fixnavi.pl script to adjust the links to the index order.
+// **********************************************************************
+
+/*!
+ \contentspage {Qt Creator Manual}
+ \previouspage creator-running-valgrind-remotely.html
+ \page creator-clang-static-analyzer.html
+ \nextpage creator-advanced.html
+
+ \title Using Clang Static Analyzer
+
+ \QC Enterprise integrates the \l{http://clang-analyzer.llvm.org}
+ {Clang Static Analyzer} for finding problems in C, C++, and Objective-C
+ programs. You must have Clang installed to use the plugin. At the time of
+ this writing, the plugin is experimental and only available on Linux and
+ OS X.
+
+ \image qtcreator-clang-static-analyzer.png
+
+ The Clang Static Analyzer runs with all the default checkers enabled. For
+ more information about the checkers, see
+ \l{http://clang-analyzer.llvm.org/available_checks.html}{Available Checkers}.
+
+ To set up the Clang Static Analyzer:
+
+ \list 1
+
+ \li Select \gui Help > \gui {About Plugins} > \gui {Code Analyzer} >
+ \gui {Clang Static Analyzer} to enable the experimental plugin.
+
+ \li Restart \QC to be able to use the plugin.
+
+ \li Select \gui Tools > \gui Options > \gui Analyzer >
+ \gui {Clang Static Analyzer} to check that the path to the Clang
+ executable is set correctly in the \gui {Clang executable} field.
+
+ \image qtcreator-clang-static-analyzer-options.png
+
+ \endlist
+
+ To run the Clang Static Analyzer to analyze an open project:
+
+ \list 1
+
+ \li Select \gui Analyze > \gui {Clang Static Analyzer}.
+
+ \li Select the
+ \inlineimage qtcreator-analyze-start-button.png
+ (\gui Start) button to run the Clang Static Analyzer on the
+ application.
+
+ \endlist
+
+*/
+
diff --git a/doc/src/analyze/creator-valgrind.qdoc b/doc/src/analyze/creator-valgrind.qdoc
index 6b475066b3..d01229b8a3 100644
--- a/doc/src/analyze/creator-valgrind.qdoc
+++ b/doc/src/analyze/creator-valgrind.qdoc
@@ -254,7 +254,7 @@
\contentspage {Qt Creator Manual}
\previouspage creator-cache-profiler.html
\page creator-running-valgrind-remotely.html
- \nextpage creator-advanced.html
+ \nextpage creator-clang-static-analyzer.html
\title Running Valgrind Tools on External Applications
diff --git a/doc/src/overview/creator-advanced.qdoc b/doc/src/overview/creator-advanced.qdoc
index 8c5a5e6e45..d3767fd756 100644
--- a/doc/src/overview/creator-advanced.qdoc
+++ b/doc/src/overview/creator-advanced.qdoc
@@ -24,7 +24,7 @@
/*!
\contentspage {Qt Creator Manual}
- \previouspage creator-running-valgrind-remotely.html
+ \previouspage creator-clang-static-analyzer.html
\page creator-advanced.html
\nextpage creator-os-supported-platforms.html
diff --git a/doc/src/qtcreator.qdoc b/doc/src/qtcreator.qdoc
index 319f9d8e2b..4960869b37 100644
--- a/doc/src/qtcreator.qdoc
+++ b/doc/src/qtcreator.qdoc
@@ -254,6 +254,7 @@
\li \l{Profiling Function Execution}
\li \l{Running Valgrind Tools on External Applications}
\endlist
+ \li \l{Using Clang Static Analyzer}
\endlist
\endlist