Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBogdan Gheorghe2005-07-27 22:05:29 +0000
committerBogdan Gheorghe2005-07-27 22:05:29 +0000
commit7656bf39b8d145bdfcb0b567242ed99e3c3851ec (patch)
treeba437fea70ecc1e1ff7ff0c4c9ad44b47d29e752
parent0ffe6cd37efbf7c6cf8777b2135887932c0a23e0 (diff)
downloadorg.eclipse.cdt-7656bf39b8d145bdfcb0b567242ed99e3c3851ec.tar.gz
org.eclipse.cdt-7656bf39b8d145bdfcb0b567242ed99e3c3851ec.tar.xz
org.eclipse.cdt-7656bf39b8d145bdfcb0b567242ed99e3c3851ec.zip
User Docs for indexer
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablectags.html5
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablefull.htm5
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_t_set_src_fold.htm116
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/indexer_importing_large_project.html50
4 files changed, 86 insertions, 90 deletions
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
index b1802eeda36..37017f0997e 100644
--- 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
@@ -138,15 +138,12 @@ Bar</a></p>
elements</a><br>
<a href="cdt_t_indexer_enablefull.htm">Enable/Disable the Full C/C++
Indexer</a><br>
-<a href="indexer_importing_large_project.html">Importing a large project</a><br>
+<a href="indexer_importing_large_project.html">Indexing a large project</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>
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
index 549069b3c53..2987afc56e5 100644
--- 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
@@ -94,15 +94,12 @@ Bar</a></p>
elements</a><br>
<a href="cdt_t_indexer_enablectags.html">Enable/Disable the CTags
Indexer</a><br>
-<a href="indexer_importing_large_project.html">Importing a large project</a><br>
+<a href="indexer_importing_large_project.html">Indexing a large project</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>
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_set_src_fold.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_set_src_fold.htm
index 876cc6b5d73..a021b7b7422 100644
--- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_set_src_fold.htm
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_set_src_fold.htm
@@ -1,69 +1,75 @@
<!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>Setting Source Folders</title>
-<link rel="stylesheet" type="text/css" href="../help.css">
+ <meta content="en-us" http-equiv="Content-Language">
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+ <title>Setting Source Folders</title>
+ <link href="../help.css" type="text/css" rel="stylesheet">
</head>
-
<body>
-
<h1>Setting Source Folders</h1>
-
-<p><i>Note that source folders can only be currently used with Standard Make projects.
- Managed Make projects treat the entire project as a source folder.</i></p>
-
-<p>Source folders are a way to cut down on a project’s indexing scope.
-You can mark the folders that are part of your day to day work or part of a subsystem that you work on.
-All files inside source folders will be indexed and are, thus, searchable.
-Note that any files pulled in by a file inside a source folder will also be indexed. </p>
-<p><img src="../images/cdt_set_src_folder.png" alt="Set source folder"></p>
-
-
+<p><i>Note that source folders can only be currently used with Standard
+Make projects. Managed Make projects treat the entire project as a
+source folder.</i></p>
+<p>Source folders are a way to cut down on a project’s indexing scope.
+You can mark the folders that are part of your day to day work or part
+of a subsystem that you work on. All files inside source folders will
+be indexed and are, thus, searchable. Note that any files pulled in by
+a file inside a source folder will also be indexed. </p>
+<p><img alt="Set source folder" src="../images/cdt_set_src_folder.png"></p>
<p>To setup source folders:
+</p>
<ol>
- <li>Right click on the project and select <b>Properties &gt; C/C++ Project Paths</b></li>
- <li>Click on the <b>Source</b> tab<br>
- By default the entire project is a source folder, which means everything will be indexed.
- This is reasonable for smaller projects but definitely not recommended for large projects. </li>
- <li>Click <b>Add folder</b> to add the folders.
- A dialog will explain exclusion filters have been added to nesting folders.
- You will see that the folder you added will be excluded from the project folder (in order to avoid including a folder twice).
- Repeat until all the folders have been added. <br>
- <b>Note: </b>Don't forget to remove the project folder (which appears by default) otherwise everything will be indexed.</li>
- <li>Click <b>OK</b>. Your view in C/C++ projects will now change.
- You should see your source folders designated with a "C" and all other source and header files icons that are in a non-source folder will change to a "hollow" C or H.</li>
+ <li>Right click on the project and select <b>Properties &gt; C/C++
+Project Paths</b></li>
+ <li>Click on the <b>Source</b> tab<br>
+By default the entire project is a source folder, which means
+everything will be indexed. This is reasonable for smaller projects but
+definitely not recommended for large projects. </li>
+ <li>Click <b>Add folder</b> to add the folders. A dialog will
+explain exclusion filters have been added to nesting folders. You will
+see that the folder you added will be excluded from the project folder
+(in order to avoid including a folder twice). Repeat until all the
+folders have been added. <br>
+ <b>Note: </b>Don't forget to remove the project folder (which
+appears by default) otherwise everything will be indexed.</li>
+ <li>Click <b>OK</b>. Your view in C/C++ projects will now change.
+You should see your source folders designated with a "C" and all other
+source and header files icons that are in a non-source folder will
+change to a "hollow" C or H.</li>
</ol>
-
-
-
-<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
+<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 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></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>
-
+<a href="../concepts/cdt_c_indexer_fullindexer.htm">Full C/C++ Indexer</a><br>
+<a href="../concepts/cdt_c_indexer_ctagsindexer.htm">CTags Indexer</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="cdt_t_indexer_enablefull.htm">Enable/Disable the Full C/C++
+Indexer</a><br>
+<a href="cdt_t_indexer_enablectags.html">Enable/Disable the CTags
+Indexer</a><a href="../tasks/cdt_t_endis_indexer.htm"><br>
+</a><a href="../tasks/cdt_t_indexer_timeout.htm"></a></p>
+<p><img height="21" width="143" alt="Related reference"
+ src="../images/ngref.gif" border="0">
+<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 alt="IBM Copyright Statement" src="../images/ng00_04a.gif">
</body>
-
-</html> \ No newline at end of file
+</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
index 340396be5a5..12496d25149 100644
--- 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
@@ -1,10 +1,12 @@
<!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">
+ <meta http-equiv="Content-Language" content="en-us">
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Indexing a large project</title>
- <link href="../help.css" type="text/css" rel="stylesheet">
+ <link rel="stylesheet" type="text/css" href="../help.css">
+ <meta content="text/html; charset=ISO-8859-1"
+ http-equiv="content-type">
</head>
<body>
<h1>Indexing a large project<br>
@@ -22,9 +24,9 @@ approach to importing large projects.<br>
<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"
+<p>&nbsp;&nbsp;&nbsp; <img style="width: 596px; height: 310px;"
src="file:///E:/CDT/3.1/eclipse/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNG"
- style="width: 596px; height: 310px;"></p>
+ alt="Import project setup"></p>
<ul>
<li>Click on <span style="font-weight: bold;">Next <br>
</span></li>
@@ -40,8 +42,8 @@ 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>
+ style="width: 654px; height: 444px;" alt="Null Indexer"
+ src="../images/indexer_import_largeproject2.PNG"><br>
</span>
<br>
<ul>
@@ -60,32 +62,28 @@ use on the project.</li>
<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;">
+<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_open_close.htm"></a><a
+ href="../concepts/cdt_c_indexer_fullindexer.htm">Full C/C++ Indexer</a><br>
+<a href="../concepts/cdt_c_indexer_ctagsindexer.htm">CTags Indexer</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>
+<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++
+<a href="cdt_t_indexer_enablefull.htm">Enable/Disable the Full C/C++
Indexer</a><br>
-<a href="../tasks/cdt_t_indexer_timeout.htm">C/C++ Indexer - Indexer
-Timeout</a><br>
+<a href="cdt_t_indexer_enablectags.html">Enable/Disable the CTags
+Indexer</a><a href="../tasks/cdt_t_indexer_timeout.htm"></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>
+<p><img style="border: 0px solid ; width: 143px; height: 21px;"
+ src="../images/ngref.gif" alt="Related reference">
<br>
<a href="../reference/cdt_u_search.htm">C/C++ search page, Search
dialog box</a>
@@ -96,10 +94,8 @@ Properties, Managed, Indexer</a>
<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>
+<img src="../images/ng00_05a.gif" alt="IBM Copyright Statement"
+ style="width: 324px; height: 14px;">
<br>
<br>
</body>

Back to the top