diff options
| author | Anton Leherbauer | 2008-11-20 09:17:20 +0000 |
|---|---|---|
| committer | Anton Leherbauer | 2008-11-20 09:17:20 +0000 |
| commit | 1633c93d362913b100df6f8f13832b7b0039b0f0 (patch) | |
| tree | 697458182bbb2a3785ddafd3f2375000ccbb2711 /doc | |
| parent | 4e56e53d051c9166a008f49bd57bdbeb17d33ff4 (diff) | |
| download | org.eclipse.cdt-1633c93d362913b100df6f8f13832b7b0039b0f0.tar.gz org.eclipse.cdt-1633c93d362913b100df6f8f13832b7b0039b0f0.tar.xz org.eclipse.cdt-1633c93d362913b100df6f8f13832b7b0039b0f0.zip | |
Bug 204243 - Missing help for navigation tools
Diffstat (limited to 'doc')
29 files changed, 473 insertions, 397 deletions
diff --git a/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml b/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml index 8e673b2ab33..929efb696d6 100644 --- a/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml +++ b/doc/org.eclipse.cdt.doc.user/contexts_CDT.xml @@ -87,6 +87,11 @@ <topic href="reference/cdt_u_c_editor_hov.htm" label="C/C++ Editor Hovers Preferences"/> </context> +<context id ="scalability_preference_page_context"> + <description>This page allows to configure editor scalability mode options. The scalability mode helps to deal with very large source files.</description> + <topic href="reference/cdt_u_c_editor_scalability.htm" + label="C/C++ Editor Scalability Preferences"/> +</context> <context id ="c_editor_typing"> <description>Click below to see help.</description> <topic href="reference/cdt_u_c_editor_typing.htm" @@ -333,12 +338,12 @@ label="Common"/> </context> <context id ="cdt_u_search"> - <description>Click below to see help.</description> + <description>Use the C/C++ Search to search for occurrences of C/C++ elements.</description> <topic href="reference/cdt_u_search.htm" label="C/C++ search page"/> </context> <context id ="open_element_dialog_context"> - <description>Click below to see help.</description> + <description>This dialog allows to open up the declaration of C/C++ classes, structures, unions, typedefs, enumerations, namespaces, functions, methods, variables and macros.</description> <topic href="reference/cdt_u_open_element.htm" label="Open Element"/> </context> @@ -497,4 +502,16 @@ label="Preferred Toolchains tab"/> </context> +<context id="type_hierarchy_view_context" title="About Type Hierarchy view"> + <description>This view displays a type's hierarchy.</description> + <topic label="Type Hierarchy view" href="reference/cdt_u_type_hierarchy_view.htm"/> +</context> +<context id="call_hierarchy_view_context" title="About Call Hierarchy view"> + <description>The Call Hierarchy shows all callers or callees of the given function.</description> + <topic label="Call Hierarchy view" href="reference/cdt_u_call_hierarchy_view.htm"/> +</context> +<context id="include_browser_view_context" title="About Include Browser view"> + <description>This view displays include file relationships.</description> + <topic label="Include Browser view" href="reference/cdt_u_include_browser_view.htm"/> +</context> </contexts> diff --git a/doc/org.eclipse.cdt.doc.user/images/c_cpp_app_preferences.png b/doc/org.eclipse.cdt.doc.user/images/c_cpp_app_preferences.png Binary files differindex b5712988806..7ce8577dd9d 100644 --- a/doc/org.eclipse.cdt.doc.user/images/c_cpp_app_preferences.png +++ b/doc/org.eclipse.cdt.doc.user/images/c_cpp_app_preferences.png diff --git a/doc/org.eclipse.cdt.doc.user/images/c_cpp_preferences.png b/doc/org.eclipse.cdt.doc.user/images/c_cpp_preferences.png Binary files differindex a7aa9c059c7..4abefc19715 100644 --- a/doc/org.eclipse.cdt.doc.user/images/c_cpp_preferences.png +++ b/doc/org.eclipse.cdt.doc.user/images/c_cpp_preferences.png diff --git a/doc/org.eclipse.cdt.doc.user/images/editor_general_preferences.png b/doc/org.eclipse.cdt.doc.user/images/editor_general_preferences.png Binary files differindex 09a192af06f..8f5679c4e01 100644 --- a/doc/org.eclipse.cdt.doc.user/images/editor_general_preferences.png +++ b/doc/org.eclipse.cdt.doc.user/images/editor_general_preferences.png diff --git a/doc/org.eclipse.cdt.doc.user/images/editor_hover_preferences.png b/doc/org.eclipse.cdt.doc.user/images/editor_hover_preferences.png Binary files differindex 39e38a02de6..d535618a326 100644 --- a/doc/org.eclipse.cdt.doc.user/images/editor_hover_preferences.png +++ b/doc/org.eclipse.cdt.doc.user/images/editor_hover_preferences.png diff --git a/doc/org.eclipse.cdt.doc.user/images/editor_scalability_preferences.png b/doc/org.eclipse.cdt.doc.user/images/editor_scalability_preferences.png Binary files differnew file mode 100644 index 00000000000..f5cb582d7e9 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/images/editor_scalability_preferences.png diff --git a/doc/org.eclipse.cdt.doc.user/images/editor_typing_preferences.png b/doc/org.eclipse.cdt.doc.user/images/editor_typing_preferences.png Binary files differindex 5d65cddc34a..bbd29c2a1a9 100644 --- a/doc/org.eclipse.cdt.doc.user/images/editor_typing_preferences.png +++ b/doc/org.eclipse.cdt.doc.user/images/editor_typing_preferences.png 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 Binary files differdeleted file mode 100644 index 954733f754b..00000000000 --- a/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_ctagsmissing.PNG +++ /dev/null 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 Binary files differdeleted file mode 100644 index 4c4798e6a9b..00000000000 --- a/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_properties.PNG +++ /dev/null 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 Binary files differdeleted file mode 100644 index 28627c401e8..00000000000 --- a/doc/org.eclipse.cdt.doc.user/images/indexer_ctags_wrongtagformat.PNG +++ /dev/null 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 Binary files differdeleted file mode 100644 index 8400fd9271f..00000000000 --- a/doc/org.eclipse.cdt.doc.user/images/indexer_fullindexer_properties.PNG +++ /dev/null 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 Binary files differdeleted file mode 100644 index d17b724d4a7..00000000000 --- a/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject1.PNG +++ /dev/null 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 Binary files differdeleted file mode 100644 index 484586410ba..00000000000 --- a/doc/org.eclipse.cdt.doc.user/images/indexer_import_largeproject2.PNG +++ /dev/null diff --git a/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound.PNG b/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound.PNG Binary files differdeleted file mode 100644 index 624253186d9..00000000000 --- a/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound.PNG +++ /dev/null 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 Binary files differdeleted file mode 100644 index 555a7ca9049..00000000000 --- a/doc/org.eclipse.cdt.doc.user/images/indexer_inclusionnotfound_problemsview.PNG +++ /dev/null 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 Binary files differindex 16989214e27..8c7df665439 100644 --- a/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG +++ b/doc/org.eclipse.cdt.doc.user/images/indexer_preference_page.PNG diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_o_ceditor_pref.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_o_ceditor_pref.htm index 4c364ecfa25..fd9b11c486e 100644 --- a/doc/org.eclipse.cdt.doc.user/reference/cdt_o_ceditor_pref.htm +++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_o_ceditor_pref.htm @@ -20,6 +20,7 @@ <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_folding.htm">Folding preferences</a><br> <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_hov.htm">Hovers preferences</a><br> <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_mark_occurrences.htm">Mark Occurrences preferences</a><br> + <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_scalability.htm">Scalability preferences</a> <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_color.htm">Syntax Coloring preferences</a><br> <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_code_temp.htm">Templates preferences</a><br> <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_typing.htm">Typing preferences</a> diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_o_ref.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_o_ref.htm index 2a34765995d..91f2472f8d1 100644 --- a/doc/org.eclipse.cdt.doc.user/reference/cdt_o_ref.htm +++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_o_ref.htm @@ -58,6 +58,7 @@ <img src="../images/trans.gif" border="0" width="150" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_folding.htm">Folding preferences</a><br> <img src="../images/trans.gif" border="0" width="150" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_hov.htm">Hovers preferences</a><br> <img src="../images/trans.gif" border="0" width="150" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_mark_occurrences.htm">Mark Occurrences preferences</a><br> + <img src="../images/trans.gif" border="0" width="150" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_scalability.htm">Scalability preferences</a><br> <img src="../images/trans.gif" border="0" width="150" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_color.htm">Syntax Coloring preferences</a><br> <img src="../images/trans.gif" border="0" width="150" height="1" alt=""><a style="text-decoration:none" href="cdt_u_code_temp.htm">Templates preferences</a><br> <img src="../images/trans.gif" border="0" width="150" height="1" alt=""><a style="text-decoration:none" href="cdt_u_c_editor_typing.htm">Typing preferences</a><br> diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_o_views.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_o_views.htm index 0acb56eeefc..3baeaa1c1ed 100644 --- a/doc/org.eclipse.cdt.doc.user/reference/cdt_o_views.htm +++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_o_views.htm @@ -22,6 +22,7 @@ <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_editor_view.htm">Editor view</a><br> <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_console_view.htm">Console view</a><br> <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_call_hierarchy_view.htm">Call Hierarchy view</a><br> + <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_type_hierarchy_view.htm">Type Hierarchy view</a><br> <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_problems_view.htm">Problems view</a><br> <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_properties_view.htm">Properties view</a><br> <img src="../images/trans.gif" border="0" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_u_search_view.htm">Search view</a><br> diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_scalability.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_scalability.htm new file mode 100644 index 00000000000..3380e096619 --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_scalability.htm @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//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>Editor Scalability preferences</title> + <link rel="stylesheet" type="text/css" href="../help.css"> +</head> +<body> + +<h1>Scalability preferences</h1> + +<p>Use the <b>Scalability</b> preference panel to configure options for dealing with large source files. Click <b>Window > Preferences > C/C++ > Editor > Scalability</b> to make changes.</p> +<img src="../images/editor_scalability_preferences.png" alt="Scalability Preferences"> + <table width="600px" cellpadding="5" cellspacing="0" border="1" > + <caption><b>Scalability Preference Options</b></caption> + <colgroup> + <col width="30%" valign="top" > + <col width="70%" valign="top" > + </colgroup> + <tbody> + <tr> + <td><dt>Alert me when scalability mode will be turned on</dt></td> + <td>If enabled, an information dialog pops up when a large file is opened + with the C/C++ Editor which exceeds the specified line limit.</td> + </tr> + <tr> + <td><dt>Enable scalability mode options when the number of lines in the file is more than</dt></td> + <td>If the number of lines in a file exceeds the specified number the C/C++ Editor will + enable scalability mode and all scalability mode options below will take effect.</td> + </tr> + <tr> + <td><dt>Enable all scalability mode options</dt></td> + <td>If enabled, all options below are enabled, too.</td> + </tr> + <tr> + <td><dt>Disable editor live parsing</dt></td> + <td>If enabled, parsing while typing will be disabled. + This disables also other features like Outline view, semantic highlighting, folding, etc.</td> + </tr> + <tr> + <td><dt>Disable semantic highlighting</dt></td> + <td>If enabled, C/C++ identifiers will not be colored.</td> + </tr> + <tr> + <td><dt>Disable syntax coloring</dt></td> + <td>If enabled, no coloring of keywords, comments and literals is done.</td> + </tr> + <tr> + <td><dt>Disable parsing-based content assist proposals</dt></td> + <td>If enabled, content assist proposals which require parsing the file will not be available.</td> + </tr> + <tr> + <td><dt>Disable content assist auto activation</dt></td> + <td>If enabled, content assist will not be activated automatically on trigger sequences, like '.', '::' or '->'.</td> + </tr> + </tbody> +</table> + +<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21"> <br> +<a href="../concepts/cdt_o_code_entry.htm">Coding aids</a></p> +<p><img border="0" src="../images/ngtasks.gif" ALT="Related tasks" width="143" height="21"> +<br> +<a href="../tasks/cdt_t_cust_cpp_editor.htm">Customizing the C/C++ editor</a><br> +<a href="../tasks/cdt_o_con_assist.htm">Working with Content Assist</a></p> +<p><img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> +<br> +<a href="cdt_o_ceditor_pref.htm">C/C++ editor preferences</a></p> +<a href="cdt_u_c_code_style_pref.htm">Code Style preferences</a></p> +<img src="../images/ng00_07.gif" ALT="IBM Copyright Statement" > + +</body> + +</html> diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_typing.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_typing.htm index f9ffbdcc5cb..7947529bb5b 100644 --- a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_typing.htm +++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_editor_typing.htm @@ -52,6 +52,11 @@ <td><dt>Escape text when pasting into a literal string</dt></td> <td>If enabled, special characters in pasted strings are escaped when pasted into an existing string literal.</td> </tr> + <tr> + <td><dt>Automatically indent - New lines and braces</dt></td> + <td>If enabled, a new line or brace will be indented according to the <a href="cdt_u_c_code_style_pref.htm">Code Style preferences</a>. + If disabled, the default Text Editor indentation strategy is applied (copy indent from previous line)</td> + </tr> </tbody> </table> diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_parser_codereader_cache_pref.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_parser_codereader_cache_pref.htm deleted file mode 100644 index e74a488bb9e..00000000000 --- a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_c_parser_codereader_cache_pref.htm +++ /dev/null @@ -1,23 +0,0 @@ -<!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>CodeReader Buffer Size preferences</title> - <link rel="stylesheet" type="text/css" href="../help.css"> -</head> -<body> - -<h1>CodeReader Buffer Size preferences</h1> - -<p>You can define what the size of the CodeReader Buffer Size is. The CodeReader Buffer is used by the parser to load files from a cache which prevents unnecessary disk and network I/O.</p> -<p><img src="../images/cdt_pref_parser.png" alt="Parser Preferences Dialog Box"></p> -<dl> - <dt>Size (MB)</dt> - <dd>Specify the size of the CodeReader Buffer in MB (default is 64).</dd> -</dl> - -</body> - -</html> diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_include_browser_view.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_include_browser_view.htm new file mode 100644 index 00000000000..625a0454d5e --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_include_browser_view.htm @@ -0,0 +1,144 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> +<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2008. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title> + Include Browser View + </title> + <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css"> + </head> + <body> + <h1> + Include Browser View + </h1> + <p> + This view shows the include relationships between source and header files. + </p> + <h2 class="Head"> + Include Browser toolbar buttons + </h2> + <p> + The Include Browser tree shows files included by the focused file or files including the focused file depending on the selection made in the + toolbar. + </p> + <table border="1" cellspacing="0" cellpadding="5" width="100%" summary="Includes viewer"> + <thead> + <tr> + <th> + <p> + Command + </p> + </th> + <th> + <p> + Description + </p> + </th> + </tr> + </thead> + <tbody> + <tr> + <td valign="top"> + <p> + Show Next Include + </p> + </td> + <td valign="top"> + <p> + This command selects the next include directive of the current file and opens it in the editor. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Show Previous Include + </p> + </td> + <td valign="top"> + <p> + This command selects the previous include directive of the current file and opens it in the editor. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Hide System Includes + </p> + </td> + <td valign="top"> + <p> + This command toggles the display of include directives with angle brackets (<>). + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Hide Includes from Inactive Code + </p> + </td> + <td valign="top"> + <p> + This command toggles the display of include directives which are contained in an inactive conditional preprocessor branch. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Show Includers + </p> + </td> + <td valign="top"> + <p> + Show files including the currently focused file. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Show Included Files + </p> + </td> + <td valign="top"> + <p> + Show files included by the currently focused file. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Show History List + </p> + </td> + <td valign="top"> + <p> + This menu displays a history of previously displayed include relationships. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Refresh View Content + </p> + </td> + <td valign="top"> + <p> + This command updates the view content by running a new query on the index database. + </p> + </td> + </tr> + </tbody> + </table> + <p> + <img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> <br> + <a href="cdt_o_views.htm">Views</a> + </p> + </body> +</html> 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 index 434074fca34..8ea77f84485 100644 --- 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 @@ -31,11 +31,15 @@ </tr> <tr> <td valign="top"><b>Skip all references (Call Hierarchy and Search will not work) </b></td> - <td valign="top">Activate this checkbox to not index references in indexed files. This prevents some portions of CDT from working, like Call Hierarchy and Search. </td> + <td valign="top">Activate this checkbox to not index references to save space and gain performance. This prevents some portions of CDT from working, like Call Hierarchy and search for references. </td> </tr> <tr> - <td valign="top"><b>Skip type references (Search fort type references will not work) </b></td> - <td valign="top">Activate this checkbox to not index type references in indexed files. This prevents some portions of CDT from working, Search. </td> + <td valign="top"><b>Skip type references (Search for type references will not work) </b></td> + <td valign="top">Activate this checkbox to not index type references. This prevents some portions of CDT from working, like Search for type references. </td> + </tr> + <tr> + <td valign="top"><b>Skip macro references (Search for macro references will not work) </b></td> + <td valign="top">Activate this checkbox to not index macro references. This prevents some portions of CDT from working, like Search for macro references. </td> </tr> <tr> <td valign="top"><b>Files to index up-front </b></td> diff --git a/doc/org.eclipse.cdt.doc.user/reference/cdt_u_type_hierarchy_view.htm b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_type_hierarchy_view.htm new file mode 100644 index 00000000000..4799356240f --- /dev/null +++ b/doc/org.eclipse.cdt.doc.user/reference/cdt_u_type_hierarchy_view.htm @@ -0,0 +1,217 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> + <head> +<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2008. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title> + Type Hierarchy View + </title> + <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css"> + </head> + <body> + <h1> + Type Hierarchy View + </h1> + <p> + This view shows the hierarchy of a type. The Type Hierarchy view consists of two panes: + </p> + <ul> + <li> + Type Hierarchy tree pane + </li> + <li> + Member list pane (optional) + </li> + </ul> + <h2 class="Head"> + Type Hierarchy tree pane toolbar buttons + </h2> + <p> + The type hierarchy tree shows supertypes, suptypes or both of a given type depending on the selection made in the + toolbar. + </p> + <table border="1" cellspacing="0" cellpadding="5" width="100%" summary="Hierarchy viewer"> + <thead> + <tr> + <th> + <p> + Command + </p> + </th> + <th> + <p> + Description + </p> + </th> + </tr> + </thead> + <tbody> + <tr> + <td valign="top"> + <p> + Show the Type Hierarchy + </p> + </td> + <td valign="top"> + <p> + This command displays the type in its full context (i.e., superclasses and subclasses) in the Hierarchy view. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Show the Supertype Hierarchy + </p> + </td> + <td valign="top"> + <p> + This command displays the supertypes in the Hierarchy view. The tree starts at the selected type and + displays the result of traversing up the hierarchy. + </p> + <em>Note: The selected type is always at the top level, in the upper-left corner.</em> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Show the Subtype Hierarchy + </p> + </td> + <td valign="top"> + <p> + This command displays the subtypes of the selected type in the Hierarchy view. The tree starts at the selected type and + displays the result of traversing down the hierarchy + </p> + <em>Note: The selected type is always at the top level, in the upper-left corner.</em> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Show History List + </p> + </td> + <td valign="top"> + <p> + This menu displays a history of previously displayed type hierarchies. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Refresh + </p> + </td> + <td valign="top"> + <p> + This command updates the view content by running a new query on the index database. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Cancel + </p> + </td> + <td valign="top"> + <p> + This command cancels a currently running query. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Layout > Hierarchy View Only + </p> + </td> + <td valign="top"> + <p> + Hides the member list pane. + </p> + </td> + </tr> + </tbody> + </table> + <h2 class="Head"> + Member list pane toolbar buttons + </h2> + <p> + The member list pane displays the members of the currently selected type in the type hierarchy tree pane. + </p> + <table border="1" cellspacing="0" cellpadding="5" width="100%" summary="Member viewer"> + <thead> + <tr> + <th> + <p> + Command + </p> + </th> + <th> + <p> + Description + </p> + </th> + </tr> + </thead> + <tbody> + <tr> + <td valign="top"> + <p> + Show All Inherited Members + </p> + </td> + <td valign="top"> + <p> + Shows or hides all methods and fields inherited by base classes. When this option is set, the name of the type that defines the method is appended to the method + name. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Hide Fields + </p> + </td> + <td valign="top"> + <p> + Shows or hides the fields. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Hide Static Fields and Methods + </p> + </td> + <td valign="top"> + <p> + Shows or hides the static fields and methods. + </p> + </td> + </tr> + <tr> + <td valign="top"> + <p> + Hide Non-Public Members + </p> + </td> + <td valign="top"> + <p> + Shows or hides the static fields and methods. + </p> + </td> + </tr> + </tbody> + </table> + <p> + <img border="0" src="../images/ngref.gif" ALT="Related reference" width="143" height="21"> <br> + <a href="cdt_o_views.htm">Views</a> + </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 deleted file mode 100644 index 0f6fbecd928..00000000000 --- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablectags.html +++ /dev/null @@ -1,159 +0,0 @@ -<!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 indexer -</h3> -To enable the CTags Indexer: -<ol> - <li>Right click on the project and select <b>Properties > 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 > 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 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 > 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 > 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_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="cdt_t_indexer_enablefull.htm">Enable/Disable the Full C/C++ -Indexer</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.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> </p> -<img src="../images/ng00_05a.gif" alt="IBM Copyright Statement" - style="width: 324px; height: 14px;"> -<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 deleted file mode 100644 index d9cffd5d7cd..00000000000 --- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_indexer_enablefull.htm +++ /dev/null @@ -1,110 +0,0 @@ -<!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 - 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 indexer</h3> -<br> -To enable the Full C/C++ Indexer: -<ol> - <li>Right click on the project and select <b>Properties > 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 > 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_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="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.htm">C/C++ search page, Search -dialog box</a> -<br> -<a href="../reference/cdt_u_prop_general_idx.htm">C/C++ Project Properties, Indexer</a> -</p> -<p> </p> -<img alt="IBM Copyright Statement" src="../images/ng00_07.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 deleted file mode 100644 index 296b9c509be..00000000000 --- a/doc/org.eclipse.cdt.doc.user/tasks/indexer_importing_large_project.html +++ /dev/null @@ -1,100 +0,0 @@ -<!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>Indexing a large project</title> - <link rel="stylesheet" type="text/css" href="../help.css"> -</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> <img style="width: 596px; height: 310px;" - src="../images/indexer_import_largeproject1.PNG" - alt="Import project setup"></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 - style="width: 654px; height: 444px;" alt="Null Indexer" - src="../images/indexer_import_largeproject2.PNG"><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 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_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 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="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_indexer_timeout.htm"></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.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> </p> -<img src="../images/ng00_05a.gif" alt="IBM Copyright Statement" - style="width: 324px; height: 14px;"> -<br> -<br> -</body> -</html> diff --git a/doc/org.eclipse.cdt.doc.user/topics_Reference.xml b/doc/org.eclipse.cdt.doc.user/topics_Reference.xml index 7bbe1f14f10..fd71e838824 100644 --- a/doc/org.eclipse.cdt.doc.user/topics_Reference.xml +++ b/doc/org.eclipse.cdt.doc.user/topics_Reference.xml @@ -18,6 +18,8 @@ <topic label="Properties view" href="reference/cdt_u_properties_view.htm"/> <topic label="Search view" href="reference/cdt_u_search_view.htm"/> <topic label="Call Hierarchy view" href="reference/cdt_u_call_hierarchy_view.htm"/> + <topic label="Type Hierarchy view" href="reference/cdt_u_type_hierarchy_view.htm"/> + <topic label="Include Browser view" href="reference/cdt_u_include_browser_view.htm"/> <topic label="Debug views" href="reference/cdt_o_dbg_view.htm"> <topic label="Registers view" href="reference/cdt_u_registersview.htm"/> <topic label="Memory view" href="reference/cdt_u_memoryview.htm"/> @@ -70,6 +72,7 @@ <topic label="Folding preferences" href="reference/cdt_u_c_editor_folding.htm"/> <topic label="Hovers preferences" href="reference/cdt_u_c_editor_hov.htm"/> <topic label="Mark Occurrences preferences" href="reference/cdt_u_c_editor_mark_occurrences.htm"/> + <topic label="Scalability preferences" href="reference/cdt_u_c_editor_scalability.htm"/> <topic label="Syntax Coloring preferences" href="reference/cdt_u_c_editor_color.htm"/> <topic label="Templates preferences" href="reference/cdt_u_code_temp.htm"/> <topic label="Typing preferences" href="reference/cdt_u_c_editor_typing.htm"/> |
