--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/core/com.nokia.carbide.cpp.doc.user/html/reference/indexer.html Fri Apr 03 23:33:03 2009 +0100
@@ -0,0 +1,68 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html><head>
+<title>Indexer</title>
+<link rel="StyleSheet" href="../../book.css" type="text/css"/>
+</head>
+ <body>
+<h2>Indexer</h2>
+<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 content assist. The goal of indexing is to record all named elements in a project's source code and store them with their related data. The indexer parses each source file in your project and updates related indexes. By indexing your files with the indexer, useful features such as code completion and fast file search can be used. It is also possible to specify different indexer settings for each project in your workspace.</p>
+ <p>If you choose to perform the Full C/C++ Indexer option the indexer will consume the CPU for some time, but you will gain more benefit from the process after it completes.
+ However, if you do not require the benefits of indexing your project, select the No Indexer option to speed up the process of building your project.</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>The Preferences Indexer can be accessed by selecting Window > Preferences then expanding the C/C++ group and selecting Indexer (figure 1). The Project Properties Indexer can be accessed by selecting a project in the C/C++ Projects or Symbian Project Navigator view and selecting Project > Properties, then select C/C++ Indexer (figure 2).</p>
+ <p class="note"><b>NOTE</b> You can also rebuild a project's index by selecting a project, right-click to display the context menu and select <b>Rebuild Index</b>. </p>
+ <p align="center" class="Image"><img src="images/indexer.png" width="663" height="439" /></p>
+ <p align="left" class="figure">Figure 1 - Indexer Window in Preferences Panels</p>
+ <p align="left" class="Image"> </p>
+ <p align="center" class="Image"><img src="images/indexer_prop.png" width="616" height="392" /></p>
+ <p align="left" class="figure">Figure 2 - Indexer Window in Project Properties</p>
+ <p align="left" class="Image"> </p>
+ <table cellpadding="2" cellspacing="0"
+border="0">
+ <tr valign="top"><th width="221" class="Cell">Name</th><th width="558" class="Cell">Function</th></tr>
+ <tr valign="top">
+ <td class="Cell"><b>Available indexers </b></td>
+ <td class="Cell"><p>Dropdown list of available index options.</p>
+ <ul>
+ <li>No Indexer - Project source files will not be indexed, therefore search features will not work accurately and code completion will not be available.</li>
+ <li>Fast C/C++ Indexer - Source files will be indexed and eat up a lot of CPU time and memory during the first generation of the indexer. This can take some time depending on the size of your project. Afterwards the indexer will only reindex the relevant parts you changed in your code and not the whole source tree.</li>
+ <li>Full C/C++ Indexer - Performs a complete parse of all source files and takes up the most amount of time to complete.</li>
+ </ul></td>
+ </tr>
+ <tr valign="top">
+ <td class="Cell"><b>Apply indexer to all projects now </b></td>
+ <td class="Cell">Select this option to apply the Fast C/C++ Indexer option to all projects in your current workspace. </td>
+ </tr>
+ <tr valign="top">
+ <td class="Cell"><b>Rebuild the index when changing to a different build configuration </b></td>
+ <td class="Cell">Select this option to rescan and index the source files for the current project when you change the active build configuration. The index will be built based on the active build configuration. All macros and header files used to build the index will be taken from the active build configuration.</td>
+ </tr>
+ <tr valign="top">
+ <td class="Cell"><p><b>Build the index only for the build configuration specified in the project's indexer settings</b></p>
+ <p> </p>
+ <p><b>Build the index only for the specified build configuration </b></p></td>
+ <td class="Cell"><p>The indexer will only be run for the build configuration specified in the Indexer panel in the project's property settings. All macros and header files used to build the index will be taken from the specified configuration.</p>
+ <p> </p>
+ <p class="note"><b>NOTE</b> This option appears in the project properties indexer panel. A dropdown list is provided to select a build configuration for the currently selected project.</p></td>
+ </tr>
+ </table>
+ <p> </p>
+ <h5>Related concepts</h5>
+ <ul>
+ <li><a href="../concepts/build_configurations.htm">Active Build Configuration</a></li>
+ </ul>
+ <h5>Related tasks </h5>
+ <ul><li><a href="../tasks/projects/prj_set_build_tgt.htm">Setting Active Build Configurations</a></li>
+ <li><a href="../tasks/projects/prj_debug_config.htm">Creating Launch Configurations</a></li>
+ <li><a href="../tasks/projects/prj_new_build_config.htm">Creating Build Configurations</a></li>
+ </ul>
+<div id="footer">Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. <br>License: <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a></div>
+
+ </body>
+ </html>
+
\ No newline at end of file