Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBogdan Gheorghe2005-07-27 16:04:02 -0400
committerBogdan Gheorghe2005-07-27 16:04:02 -0400
commitf7ea41ecca36768e078efd33383de4461e96f527 (patch)
tree64eac990faea2c2cc68740c2bf6e56b0723f34a2
parent888428b1fa6a9a8b854cf0a15f868a3072690bd5 (diff)
downloadorg.eclipse.cdt-f7ea41ecca36768e078efd33383de4461e96f527.tar.gz
org.eclipse.cdt-f7ea41ecca36768e078efd33383de4461e96f527.tar.xz
org.eclipse.cdt-f7ea41ecca36768e078efd33383de4461e96f527.zip
User Docs for indexer
-rw-r--r--doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer.htm99
-rw-r--r--doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_ctagsindexer.htm64
-rw-r--r--doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_fullindexer.htm59
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/indexer_ctags_ctagsmissing.PNGbin0 -> 8321 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/indexer_ctags_properties.PNGbin0 -> 31223 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/indexer_ctags_wrongtagformat.PNGbin0 -> 8202 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/indexer_fullindexer_properties.PNGbin0 -> 27376 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNGbin0 -> 17185 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject2.PNGbin0 -> 24702 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound.PNGbin0 -> 3299 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound_problemsview.PNGbin0 -> 8179 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNGbin0 -> 29039 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html38
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablectags.html167
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablefull.htm121
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/indexer_importing_large_project.html106
16 files changed, 615 insertions, 39 deletions
diff --git a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer.htm
index 25a6c3560f4..da31eae02d3 100644
--- a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer.htm
+++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer.htm
@@ -1,56 +1,77 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html lang="en">
-
<head>
-<meta http-equiv="Content-Language" content="en-us">
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<title>C/C++ Indexer</title>
-<link rel="stylesheet" type="text/css" href="../help.css">
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>C/C++ Indexer</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
</head>
-
<body>
-
<h1>C/C++ Indexer</h1>
-
-<p>The C/C++ indexer uses the parser to create a database of your source and header files that provides the basis for C/C++ search, navigation features and parts of content assist.</p>
-
-<p>The indexer runs on a background thread and reacts to resource change events such as:
+<p>The C/C++ indexer uses the parser to create a database of your
+source and header files that provides the basis for C/C++ search,
+navigation features and parts of content assist.</p>
+<p>The indexer runs on a background thread and reacts to resource
+change events such as:
+</p>
<ul>
<li>C/C++ project creation/deletion</li>
<li>Source files creation/deletion</li>
<li>File imports</li>
<li>Source file content changes</li>
-</ul></p>
-
-<p>It is possible to customize the behavior of the indexer through the use of source folders or even turn it off completely.
-This customizable behavior is available on a per-project basis (i.e. it is possible to have different indexer settings for each project in your workspace).</p>
-
-<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
-<br>
-<a href="cdt_c_search.htm">C/C++ search</a><br>
+</ul>
+<p>It is possible to customize the behavior of the indexer through the
+use of source folders or even turn it off completely. This customizable
+behavior is available on a per-project basis (i.e. it is possible to
+have different indexer settings for each project in your workspace). <br>
+</p>
+<p>CDT 3.0 supports the contribution of additional indexers, with 2
+indexers being provided with the default CDT release:<br>
+</p>
+<ul>
+ <li>Full C/C++ Indexer : provides full indexing capabilities - both
+declarations and cross reference information.<br>
+ </li>
+ <li>CTags Indexer: provides partial indexing capabilities - only
+declaration information. <br>
+ </li>
+</ul>
+<p><img border="0" src="../images/ngconcepts.gif" alt="Related concepts"
+ width="143" height="21"> <br>
+<a href="cdt_c_indexer_fullindexer.htm">Full C/C++ Indexer</a><a
+ href="cdt_c_search.htm"><br>
+C/C++ search</a><br>
<a href="cdt_c_indexer_prob_rep.htm">C/C++ Indexer Problem Reporting</a><br>
-<a href="cdt_c_indexer_open_close.htm">C/C++ Indexer Opening or Closing a project</a><br>
+<a href="cdt_c_indexer_open_close.htm">C/C++ Indexer Opening or Closing
+a project</a><br>
<a href="cdt_c_indexer_prog_bar.htm">C/C++ Indexer Progress Bar</a></p>
-
-
-<p><img border="0" src="../images/ngtasks.gif" ALT="Related tasks" width="143" height="21"><br>
-<a href="../tasks/cdt_t_sel_search.htm">Selection Searching for C/C++ elements</a><br>
-<a href="../tasks/cdt_t_endis_indexer.htm">Enable/Disable the C/C++ Indexer</a><br>
-<a href="../tasks/cdt_t_indexer_prob_rep.htm">C/C++ Indexer Problem Reporting</a><br>
-<a href="../tasks/cdt_t_indexer_timeout.htm">C/C++ Indexer - Indexer Timeout</a><br>
+<p><img border="0" src="../images/ngtasks.gif" alt="Related tasks"
+ width="143" height="21"><br>
+<a href="../tasks/cdt_t_sel_search.htm">Selection Searching for C/C++
+elements</a><br>
+<a href="../tasks/cdt_t_endis_indexer.htm">Enable/Disable the C/C++
+Indexer</a><br>
+<a href="../tasks/cdt_t_indexer_prob_rep.htm">C/C++ Indexer Problem
+Reporting</a><br>
+<a href="../tasks/cdt_t_indexer_timeout.htm">C/C++ Indexer - Indexer
+Timeout</a><br>
<a href="../tasks/cdt_t_set_src_fold.htm">Setting Source Folders</a><br>
</p>
-
-
-<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21">
-<br><a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences window</a>
-<br><a href="../reference/cdt_u_search.htm">C/C++ search page, Search dialog box</a>
-<br><a href="../reference/cdt_u_mprop_indexer.htm">C/C++ Project Properties, Managed, Indexer</a>
-<br><a href="../reference/cdt_u_sprop_indexer.htm">C/C++ Project Properties, Standard, Indexer</a></p>
-
+<p><img border="0" src="../images/ngref.gif" alt="Related reference"
+ width="143" height="21">
+<br>
+<a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences
+window</a>
+<br>
+<a href="../reference/cdt_u_search.htm">C/C++ search page, Search
+dialog box</a>
+<br>
+<a href="../reference/cdt_u_mprop_indexer.htm">C/C++ Project
+Properties, Managed, Indexer</a>
+<br>
+<a href="../reference/cdt_u_sprop_indexer.htm">C/C++ Project
+Properties, Standard, Indexer</a></p>
<p>&nbsp;</p>
-<img src="../images/ng00_04a.gif" ALT="IBM Copyright Statement" >
-
+<img src="../images/ng00_04a.gif" alt="IBM Copyright Statement">
</body>
-
-</html> \ No newline at end of file
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_ctagsindexer.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_ctagsindexer.htm
new file mode 100644
index 00000000000..f03d2c78b37
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_ctagsindexer.htm
@@ -0,0 +1,64 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>CTags Indexer</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
+</head>
+<body>
+<h1>CTags Indexer</h1>
+<p>The CTags indexer makes use of Exuberant CTags (version 5.5.4) to
+create an index of the source and header files in your project. The
+main advantage provided by CTags is that the index creation is very
+quick. This makes it ideal to use on larger sized projects.&nbsp; <br>
+</p>
+<p>CTags, however, does not provide the same level of detail in
+indexing as the Full C/C++ indexer. Specifically:<br>
+</p>
+<ul>
+ <li>no cross reference information</li>
+ <li>each file is processed on its own<br>
+ </li>
+ <li>limited preprocessing capabilties<br>
+ </li>
+</ul>
+<p><img border="0" src="../images/ngconcepts.gif" alt="Related concepts"
+ width="143" height="21"> <br>
+<a href="cdt_c_indexer_fullindexer.htm">Full C/C++ Indexer</a><br>
+<a href="cdt_c_search.htm">C/C++ search</a><br>
+<a href="cdt_c_indexer_prob_rep.htm">C/C++ Indexer Problem Reporting</a><br>
+<a href="cdt_c_indexer_open_close.htm">C/C++ Indexer Opening or Closing
+a project</a><br>
+<a href="cdt_c_indexer_prog_bar.htm">C/C++ Indexer Progress Bar</a></p>
+<p><img border="0" src="../images/ngtasks.gif" alt="Related tasks"
+ width="143" height="21"><br>
+<a href="../tasks/cdt_t_sel_search.htm">Selection Searching for C/C++
+elements</a><br>
+<a href="../tasks/cdt_t_endis_indexer.htm">Enable/Disable the C/C++
+Indexer</a><br>
+<a href="../tasks/cdt_t_indexer_prob_rep.htm">C/C++ Indexer Problem
+Reporting</a><br>
+<a href="../tasks/cdt_t_indexer_timeout.htm">C/C++ Indexer - Indexer
+Timeout</a><br>
+<a href="../tasks/cdt_t_set_src_fold.htm">Setting Source Folders</a><br>
+</p>
+<p><img border="0" src="../images/ngref.gif" alt="Related reference"
+ width="143" height="21">
+<br>
+<a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences
+window</a>
+<br>
+<a href="../reference/cdt_u_search.htm">C/C++ search page, Search
+dialog box</a>
+<br>
+<a href="../reference/cdt_u_mprop_indexer.htm">C/C++ Project
+Properties, Managed, Indexer</a>
+<br>
+<a href="../reference/cdt_u_sprop_indexer.htm">C/C++ Project
+Properties, Standard, Indexer</a></p>
+<p>&nbsp;</p>
+<img src="../images/ng00_05a.gif" alt="IBM Copyright Statement"
+ style="width: 324px; height: 14px;">
+</body>
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_fullindexer.htm b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_fullindexer.htm
new file mode 100644
index 00000000000..be75141a5f3
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/concepts/cdt_c_indexer_fullindexer.htm
@@ -0,0 +1,59 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="en-us" http-equiv="Content-Language">
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+ <title>Full C/C++ Indexer</title>
+ <link href="../help.css" type="text/css" rel="stylesheet">
+</head>
+<body>
+<h1>Full C/C++ Indexer</h1>
+<p>The Full C/C++ Indexer is a new indexer for CDT 3.0 which makes use
+of the new DOM. It creates a full index of the project's source
+providing both declaration and cross reference information to the
+various clients that make use of the index. In comparison with the
+previous versions of the indexer, the new C/C++ indexer provides
+quicker and more accurate results.<br>
+</p>
+<p>This indexer provides the most complete set of information but can
+be potentially long running, especially on larger projects. <br>
+</p>
+<p><img height="21" width="143" alt="Related concepts"
+ src="../images/ngconcepts.gif" border="0"> <br>
+<a href="cdt_c_indexer.htm">C/C++ Indexer</a><br>
+<a href="cdt_c_search.htm">C/C++ search</a><br>
+<a href="cdt_c_indexer_prob_rep.htm">C/C++ Indexer Problem Reporting</a><br>
+<a href="cdt_c_indexer_open_close.htm">C/C++ Indexer Opening or Closing
+a project</a><br>
+<a href="cdt_c_indexer_prog_bar.htm">C/C++ Indexer Progress Bar</a></p>
+<p><img height="21" width="143" alt="Related tasks"
+ src="../images/ngtasks.gif" border="0"><br>
+<a href="../tasks/cdt_t_sel_search.htm">Selection Searching for C/C++
+elements</a><br>
+<a href="../tasks/cdt_t_endis_indexer.htm">Enable/Disable the C/C++
+Indexer</a><br>
+<a href="../tasks/cdt_t_indexer_prob_rep.htm">C/C++ Indexer Problem
+Reporting</a><br>
+<a href="../tasks/cdt_t_indexer_timeout.htm">C/C++ Indexer - Indexer
+Timeout</a><br>
+<a href="../tasks/cdt_t_set_src_fold.htm">Setting Source Folders</a><br>
+</p>
+<p><img height="21" width="143" alt="Related reference"
+ src="../images/ngref.gif" border="0">
+<br>
+<a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences
+window</a>
+<br>
+<a href="../reference/cdt_u_search.htm">C/C++ search page, Search
+dialog box</a>
+<br>
+<a href="../reference/cdt_u_mprop_indexer.htm">C/C++ Project
+Properties, Managed, Indexer</a>
+<br>
+<a href="../reference/cdt_u_sprop_indexer.htm">C/C++ Project
+Properties, Standard, Indexer</a></p>
+<p>&nbsp;</p>
+<img alt="IBM Copyright Statement" src="../images/ng00_05a.gif"
+ style="width: 324px; height: 14px;">
+</body>
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_ctagsmissing.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_ctagsmissing.PNG
new file mode 100644
index 00000000000..954733f754b
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_ctagsmissing.PNG
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_properties.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_properties.PNG
new file mode 100644
index 00000000000..4c4798e6a9b
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_properties.PNG
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_wrongtagformat.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_wrongtagformat.PNG
new file mode 100644
index 00000000000..28627c401e8
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_wrongtagformat.PNG
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_fullindexer_properties.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_fullindexer_properties.PNG
new file mode 100644
index 00000000000..8400fd9271f
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/indexer_fullindexer_properties.PNG
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNG
new file mode 100644
index 00000000000..d17b724d4a7
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNG
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject2.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject2.PNG
new file mode 100644
index 00000000000..484586410ba
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject2.PNG
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound.PNG
new file mode 100644
index 00000000000..624253186d9
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound.PNG
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound_problemsview.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound_problemsview.PNG
new file mode 100644
index 00000000000..555a7ca9049
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound_problemsview.PNG
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG
new file mode 100644
index 00000000000..7aa43429697
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html
new file mode 100644
index 00000000000..3e6638d8e9f
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_indexer_preference.html
@@ -0,0 +1,38 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>Indexer Preference Page</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
+</head>
+<body>
+<h1>Indexer Preference Page</h1>
+<p> <img src="../images/indexer_preference_page.PNG"
+ alt="Indexer Preferences Window" style="width: 580px; height: 532px;"><br>
+</p>
+<p>The indexer preference page allows you to select which indexer is to
+be used as a default for new projects.</p>
+<p><img style="border: 0px solid ; width: 143px; height: 21px;"
+ src="../images/ngconcepts.gif" alt="Related concepts"> <br>
+<a href="../concepts/cdt_o_code_entry.htm">Coding aids</a><br>
+<a href="../concepts/cdt_c_search.htm">C/C++ search</a></p>
+<p><img style="border: 0px solid ; width: 143px; height: 21px;"
+ src="../images/ngtasks.gif" alt="Related tasks"> <br>
+<a href="../tasks/cdt_t_search.htm">Searching for C/C++ elements</a><br>
+<a href="../tasks/cdt_t_cust_cpp_editor.htm">Customizing the C/C++
+editor</a></p>
+<p><img style="border: 0px solid ; width: 143px; height: 21px;"
+ src="../images/ngref.gif" alt="Related reference">
+<br>
+<a href="cdt_u_search.htm">C/C++ search page, Search window</a><br>
+<a href="cdt_u_m_search.htm">Search action</a><br>
+<a href="cdt_u_search_view.htm">Search view</a><br>
+</p>
+<p><img src="../images/ng00_05a.gif" alt="Copyright"
+ style="width: 324px; height: 14px;"><br>
+</p>
+<p>
+</p>
+</body>
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablectags.html b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablectags.html
new file mode 100644
index 00000000000..712fae08169
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablectags.html
@@ -0,0 +1,167 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <title>Enable/Disable CTags Indexer</title>
+ <link rel="stylesheet" type="text/css" href="../help.css">
+</head>
+<body>
+<h1>Enable/Disable CTags Indexer</h1>
+<p>Users can choose which indexer they wish to use on a specific
+project by bringing up the project properties and <br>
+selecting an indexer from the available indexer list.<br>
+</p>
+<p><img alt="CTags Indexer Properties"
+ src="../images/indexer_ctags_properties.PNG"
+ style="width: 659px; height: 532px;"></p>
+<h2>Enable CTags Indexer</h2>
+<h3><span style="font-weight: bold;"></span>Enabling the&nbsp; indexer
+</h3>
+To enable the CTags Indexer:
+<ol>
+ <li>Right click on the project and select <b>Properties &gt; C/C++
+Indexer</b></li>
+ <li>Select the <b>CTags Indexer (declarations only) </b>from the
+list of available indexers<br>
+ </li>
+ <li>Click <b>OK</b></li>
+</ol>
+This will throw away whatever old index was around for the current
+project and start a new reindex of the entire project using the CTags<br>
+indexer and whatever options are present on the property page.<br>
+<h3>CTags Location<br>
+</h3>
+By default, the CTags Indexer expects that Ctags has been added to the
+path and will try to use it. To use another CTags:<br>
+<br>
+<ol>
+ <li>Right click on the project and select <b>Properties &gt; C/C++
+Indexer</b></li>
+ <li>Click the <b>Use the specified CTags </b>button</li>
+ <li>Click on the <span style="font-weight: bold;">Browse...</span>
+button</li>
+ <li>Navigate to the location of the desired CTags</li>
+ <li>Select the CTags executable and click <span
+ style="font-weight: bold;">Open</span></li>
+</ol>
+The path of&nbsp; the given CTags executable is displayed in the CTags
+location box. When indexing the current project from now<br>
+on, the CTags indexer will now use whatever CTags is displayed on the
+path.<br>
+<br>
+If the CTags indexer can't find the location of your CTags or can't use
+the specified CTags it will let you know in the form<br>
+of a warning marker.<br>
+<br>
+<img src="../images/indexer_ctags_ctagsmissing.PNG" alt="CTags missing"
+ style="width: 682px; height: 138px;"><br>
+<h3>Include Files<br>
+</h3>
+Checking this box will cause the CTags indexer to index all of the
+files on the project's include paths.<br>
+<br>
+<h3>CTags File<br>
+</h3>
+By default, the CTags indexer runs CTags on your project and stores the
+output in an internal file before adding the entries<br>
+to the index. If you have an already existing CTag output file, you can
+get import it into the index. To do this:<br>
+<br>
+<ol>
+ <li>Right click on the project and select <b>Properties &gt; C/C++
+Indexer</b></li>
+ <li>Click th<span style="font-weight: bold;">e Import existing CTags
+file</span> button</li>
+ <li>Browse to the CTags location</li>
+ <li>Click <span style="font-weight: bold;">OK</span></li>
+ <li><span style="font-weight: bold;"><span style="font-weight: bold;"><span
+ style="font-weight: bold;"></span></span></span><span
+ style="font-weight: bold;"><span style="font-weight: bold;"><span
+ style="font-weight: bold;"></span></span></span>Close and reopen the
+project<span style="font-weight: bold;"><br>
+ </span></li>
+</ol>
+The CTags Indexer will now attempt to import your CTags file. <br>
+<br>
+Note that the CTags indexer expects a certain format for the CTags
+file. In order for an external file to be imported <br>
+by the CTags indexer, the following conditions must be met:<br>
+<ol>
+ <li>Exuberant CTags version 5.5.4 was used</li>
+ <li>The following options are run with CTags:</li>
+</ol>
+<ul>
+ <li>--excmd=number</li>
+ <li>--format=2</li>
+ <li>--fields=aiKlmnsSz<br>
+ </li>
+ <li>--c-types=cdefgmnpstuvx<br>
+ </li>
+ <li>--c++-types=cdefgmnpstuvx<br>
+ </li>
+ <li>--languages=c,c++</li>
+</ul>
+<br>
+If the CTags indexer cannot parse the given CTag file it will tell you
+what the problem is in the form of a warning marker:<br>
+<br>
+<img src="../images/indexer_ctags_wrongtagformat.PNG"
+ alt="CTag wrong format" style="width: 706px; height: 122px;"><br>
+<br>
+<h2>Disable CTags Indexer</h2>
+<br>
+To disable the CTags Indexer:
+<ol>
+ <li>Right click on the project and select <b>Properties &gt; C/C++
+Indexer</b></li>
+ <li>Select the <span style="font-weight: bold;">No Indexer (search
+based features will not work correctly)</span></li>
+ <li>Click <b>OK</b></li>
+</ol>
+This will stop any ongoing indexes and disconnect the project from
+reacting to resource changes.<br>
+<p><img style="border: 0px solid ; width: 143px; height: 21px;"
+ src="../images/ngconcepts.gif" alt="Related concepts">
+<br>
+<a href="../concepts/cdt_c_search.htm">C/C++ search</a><br>
+<a href="../concepts/cdt_c_indexer.htm">C/C++ Indexer</a><br>
+<a href="../concepts/cdt_c_indexer_prob_rep.htm">C/C++ Indexer Problem
+Reporting</a><br>
+<a href="../concepts/cdt_c_indexer_open_close.htm">C/C++ Indexer
+Opening or Closing a project</a><br>
+<a href="../concepts/cdt_c_indexer_prog_bar.htm">C/C++ Indexer Progress
+Bar</a></p>
+<p><img style="border: 0px solid ; width: 143px; height: 21px;"
+ src="../images/ngtasks.gif" alt="Related tasks"><br>
+<a href="../tasks/cdt_t_sel_search.htm">Selection Searching for C/C++
+elements</a><br>
+<a href="../tasks/cdt_t_endis_indexer.htm">Enable/Disable the C/C++
+Indexer</a><br>
+<a href="../tasks/cdt_t_indexer_timeout.htm">C/C++ Indexer - Indexer
+Timeout</a><br>
+<a href="../tasks/cdt_t_set_src_fold.htm">Setting Source Folders</a><br>
+</p>
+<p><img style="border: 0px solid ; width: 143px; height: 21px;"
+ src="../images/ngref.gif" alt="Related reference">
+<br>
+<a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences
+window</a>
+<br>
+<a href="../reference/cdt_u_search.htm">C/C++ search page, Search
+dialog box</a>
+<br>
+<a href="../reference/cdt_u_mprop_indexer.htm">C/C++ Project
+Properties, Managed, Indexer</a>
+<br>
+<a href="../reference/cdt_u_sprop_indexer.htm">C/C++ Project
+Properties, Standard, Indexer</a></p>
+<p>&nbsp;</p>
+<img src="../images/ng00_05a.gif" alt="IBM Copyright Statement"
+ style="width: 324px; height: 14px;">
+<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type">
+<title></title>
+<br>
+<br>
+</body>
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablefull.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablefull.htm
new file mode 100644
index 00000000000..094cb54faa1
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablefull.htm
@@ -0,0 +1,121 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="en-us" http-equiv="Content-Language">
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+ <title>Enable/Disable Full C/C++ Indexer</title>
+ <link href="../help.css" type="text/css" rel="stylesheet">
+</head>
+<body>
+<h1>Enable/Disable Full C/C++ Indexer</h1>
+<p>Users can choose which indexer they wish to use on a specific
+project by bringing up the project properties and <br>
+selecting an indexer from the available indexer list.<br>
+</p>
+<p><img style="width: 580px; height: 532px;"
+ src="../images/indexer_fullindexer_properties.PNG"
+ alt="Full C/C++ Indexer Properties"></p>
+<h2>Enable Full C/C++ Indexer</h2>
+<h3>Build Info</h3>
+<br>
+In order for the Full C/C++ Indexer to successfully index your project,
+it is necessary to set up your project's build info.<br>
+This build info is used by the parser to find the paths specified
+within your source files. Note that <span style="font-style: italic;">without
+any build info, </span><br style="font-style: italic;">
+<span style="font-style: italic;">the full C/C++ indexer will just skip
+over all files</span>. <br>
+<br>
+For <span style="font-weight: bold;">Managed Make</span> projects,
+some build info is provided by default when a project gets first
+created. This default info is<br>
+enough to allow the indexer to index the entire project. However, it is
+possible that some internal include paths could still be <br>
+missing. In this case a warning marker will appear next to the
+inclusion that was not found and a corresponding entry will appear<br>
+in the Problems view.<br>
+<br>
+<img src="../images/indexer_inclusionnotfound.PNG"
+ alt="Preprocessor inclusion not found"
+ style="width: 326px; height: 62px;"><br>
+<br>
+<br>
+<img src="../images/indexer_inclusionnotfound_problemsview.PNG"
+ alt="Inclusion Problems View" style="width: 701px; height: 103px;"><br>
+<br>
+For <span style="font-weight: bold;">Standard Make</span> projects, no
+build info is provided by default. However, if you rebuild your project
+the Scanner Discovery will<br>
+kick in - regardless if you have an actual makefile -&nbsp; and
+populate some default build info. For more information see the <a
+ href="cdt_t_discovery.htm">Set Discovery <br>
+Options</a> page.<br>
+<br>
+For both types of projects you can always add build paths manually by
+right clicking on the project properties.<br>
+<h3>Enabling the&nbsp; indexer</h3>
+<br>
+To enable the Full C/C++ Indexer:
+<ol>
+ <li>Right click on the project and select <b>Properties &gt; C/C++
+Indexer</b></li>
+ <li>Select the <b>Full C/C++ Indexer (declarations and cross
+references)</b></li>
+ <li>Click <b>OK</b></li>
+</ol>
+This will throw away whatever old index was around for the current
+project and start a new reindex of the entire project using the full<br>
+C/C++ Indexer.<br>
+<br>
+<h2>Disable Full C/C++ Indexer</h2>
+<br>
+To disable the Full C/C++ Indexer:
+<ol>
+ <li>Right click on the project and select <b>Properties &gt; C/C++
+Indexer</b></li>
+ <li>Select the <span style="font-weight: bold;">No Indexer (search
+based features will not work correctly)</span><b></b></li>
+ <li>Click <b>OK</b></li>
+</ol>
+This will stop any ongoing indexes and disconnect the project from
+reacting to resource changes.<br>
+<p><img height="21" width="143" alt="Related concepts"
+ src="../images/ngconcepts.gif" border="0">
+<br>
+<a href="../concepts/cdt_c_search.htm">C/C++ search</a><br>
+<a href="../concepts/cdt_c_indexer.htm">C/C++ Indexer</a><br>
+<a href="../concepts/cdt_c_indexer_prob_rep.htm">C/C++ Indexer Problem
+Reporting</a><br>
+<a href="../concepts/cdt_c_indexer_open_close.htm">C/C++ Indexer
+Opening or Closing a project</a><br>
+<a href="../concepts/cdt_c_indexer_prog_bar.htm">C/C++ Indexer Progress
+Bar</a></p>
+<p><img height="21" width="143" alt="Related tasks"
+ src="../images/ngtasks.gif" border="0"><br>
+<a href="../tasks/cdt_t_sel_search.htm">Selection Searching for C/C++
+elements</a><br>
+<a href="../tasks/cdt_t_endis_indexer.htm">Enable/Disable the C/C++
+Indexer</a><br>
+<a href="../tasks/cdt_t_indexer_timeout.htm">C/C++ Indexer - Indexer
+Timeout</a><br>
+<a href="../tasks/cdt_t_set_src_fold.htm">Setting Source Folders</a><br>
+</p>
+<p><img height="21" width="143" alt="Related reference"
+ src="../images/ngref.gif" border="0">
+<br>
+<a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences
+window</a>
+<br>
+<a href="../reference/cdt_u_search.htm">C/C++ search page, Search
+dialog box</a>
+<br>
+<a href="../reference/cdt_u_mprop_indexer.htm">C/C++ Project
+Properties, Managed, Indexer</a>
+<br>
+<a href="../reference/cdt_u_sprop_indexer.htm">C/C++ Project
+Properties, Standard, Indexer</a></p>
+<p>&nbsp;</p>
+<img alt="IBM Copyright Statement" src="../images/ng00_05a.gif"
+ style="width: 324px; height: 14px;">
+</body>
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/indexer_importing_large_project.html b/doc/org.eclipse.cdt.doc.user/tasks/indexer_importing_large_project.html
new file mode 100644
index 00000000000..340396be5a5
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/tasks/indexer_importing_large_project.html
@@ -0,0 +1,106 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta content="en-us" http-equiv="Content-Language">
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+ <title>Indexing a large project</title>
+ <link href="../help.css" type="text/css" rel="stylesheet">
+</head>
+<body>
+<h1>Indexing a large project<br>
+</h1>
+<p>Although any indexer can be used to index an existing project at any
+time, the following steps present a recommended<br>
+approach to importing large projects.<br>
+</p>
+<ul>
+ <li>
+ <p>Create a new Standard or Managed project.</p>
+ </li>
+</ul>
+<ul>
+ <li>Uncheck the <span style="font-weight: bold;">Use default</span>
+button and browse to the root directory of your project</li>
+</ul>
+<p>&nbsp;&nbsp;&nbsp; <img alt="Import project setup"
+ src="file:///E:/CDT/3.1/eclipse/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNG"
+ style="width: 596px; height: 310px;"></p>
+<ul>
+ <li>Click on <span style="font-weight: bold;">Next <br>
+ </span></li>
+</ul>
+<ul>
+ <li>In both Managed Projects and Standard Projects, you eventually
+get to a page that contains the tab <span style="font-weight: bold;">C/C++
+Indexer</span></li>
+</ul>
+<ul>
+ <li>Select <span style="font-weight: bold;">No Indexer - </span>this
+will disable all indexing for now<br>
+ </li>
+</ul>
+<span style="font-weight: bold;"><img
+ src="../images/indexer_import_largeproject2.PNG" alt="Null Indexer"
+ style="width: 654px; height: 444px;"><br>
+</span>
+<br>
+<ul>
+ <li>Click Finish to create the project</li>
+</ul>
+<ul>
+ <li>Set your include paths either by manually entering the include
+paths or, in the case of a standard make project, <br>
+performing a build</li>
+</ul>
+<ul>
+ <li>Once the project has include path information, bring up the
+project properties and select which indexer you wish to <br>
+use on the project.</li>
+</ul>
+<br>
+By following these steps, you are making sure that the time spent
+indexing will produce meaningful results.<br>
+<p><img alt="Related concepts" src="../images/ngconcepts.gif"
+ style="border: 0px solid ; width: 143px; height: 21px;">
+<br>
+<a href="../concepts/cdt_c_search.htm">C/C++ search</a><br>
+<a href="../concepts/cdt_c_indexer.htm">C/C++ Indexer</a><br>
+<a href="../concepts/cdt_c_indexer_prob_rep.htm">C/C++ Indexer Problem
+Reporting</a><br>
+<a href="../concepts/cdt_c_indexer_open_close.htm">C/C++ Indexer
+Opening or Closing a project</a><br>
+<a href="../concepts/cdt_c_indexer_prog_bar.htm">C/C++ Indexer Progress
+Bar</a></p>
+<p><img alt="Related tasks" src="../images/ngtasks.gif"
+ style="border: 0px solid ; width: 143px; height: 21px;"><br>
+<a href="../tasks/cdt_t_sel_search.htm">Selection Searching for C/C++
+elements</a><br>
+<a href="../tasks/cdt_t_endis_indexer.htm">Enable/Disable the C/C++
+Indexer</a><br>
+<a href="../tasks/cdt_t_indexer_timeout.htm">C/C++ Indexer - Indexer
+Timeout</a><br>
+<a href="../tasks/cdt_t_set_src_fold.htm">Setting Source Folders</a><br>
+</p>
+<p><img alt="Related reference" src="../images/ngref.gif"
+ style="border: 0px solid ; width: 143px; height: 21px;">
+<br>
+<a href="../reference/cdt_u_search_pref.htm">Search, C/C++ Preferences
+window</a>
+<br>
+<a href="../reference/cdt_u_search.htm">C/C++ search page, Search
+dialog box</a>
+<br>
+<a href="../reference/cdt_u_mprop_indexer.htm">C/C++ Project
+Properties, Managed, Indexer</a>
+<br>
+<a href="../reference/cdt_u_sprop_indexer.htm">C/C++ Project
+Properties, Standard, Indexer</a></p>
+<p>&nbsp;</p>
+<img style="width: 324px; height: 14px;" alt="IBM Copyright Statement"
+ src="../images/ng00_05a.gif">
+<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
+<title></title>
+<br>
+<br>
+</body>
+</html>

Back to the top