mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-22 22:22:11 +02:00
Code Issues Wiki Activity

From Dave Williams: Contains fixes to html links, update to What's New and added content for Code Assist.

Browse source
This commit is contained in:
David Daoust 2004-04-11 13:11:23 +00:00
parent 864b6075c5
commit 8bcd0490f9
8 changed files with 214 additions and 137 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
doc/org.eclipse.cdt.doc.user/concepts/cdt_c_comments.htm
View file

@ -3,8 +3,6 @@
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Comments</title>
<link rel="stylesheet" type="text/css" href="../help.css">
@ -14,14 +12,33 @@
<h1>Comments</h1>
<p>You can select one or more lines of code, right-click, and click <b>Comment</b>
to add the leading characters <samp>//</samp> to the beginning of lines. When
you uncomment lines of code, the leading <samp>//</samp> characters are removed
from the selected lines.</p>
<h3>Comment</h3>
<p>You can quickly comment out one or more lies of code by inserting the leading
characters <samp>//</samp> at the beginning of the line. To do so, select the line
(or lines) of code you want to comment out and press <b>CTRL+/</b> (slash).</p>
<p><b>Tip:</b> The characters <samp>/* */</samp> on lines that already are
<h3>Uncomment</h3>
<p>To uncomment select the line (or lines) of code, and press <b>CTRL+\</b>
(backslash).
<p><b>Tip:</b> The characters <samp>/* */</samp> on lines that are
already commented out, are not affected when you comment and uncomment code.</p>
<h3>Multiline comment</h3>
<p>You can use the Content Assist feature to insert a multiline comment before a method.
Type <tt>com+Ctrl+Space</tt>, and the following code is entered at the cursor location:
<br><pre>
/*
* author userid
*
* To change this generated comment edit the template variable "comment":
* Window>Preferences>C>Templates.
*/
</pre>
To change the default comment click <b>Window > Preferences > C > Templates</b>. For more information see the
<a href="cdt_c_content_assist.htm">Content Assist</a> section.
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
<br>
<a href="cdt_c_content_assist.htm">Content Assist and code completion</a></p>

92
doc/org.eclipse.cdt.doc.user/concepts/cdt_c_content_assist.htm
View file

@ -2,75 +2,79 @@
<html lang="en">
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Content assist</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>Content assist</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head>
<body>
<h1>Content assist</h1>
<h1>Content Assist</h1>
<p>In the C/C++ editor, when you enter a letter combination in the editor,
right-click and click <b>Content Assist</b>. A list of code elements and code
templates that start with the letter combination that you typed is displayed.</p>
<p>Content Assist is a set of tools built into the CDT that can reduce the number of keystrokes you must
type to create your code. The Content Assist plugin consists of several components that forecast what
a developer will type, based on the current context, scope, and prefix.</p>
<h2>Code Completion</h2>
<h2>Code completion</h2>
<p>Content assist provides code completion assistance while you code from within
the body of a method or a function. For the current project
and any referenced projects, a list is displayed of the elements that begin with the
letter combination you entered in the order shown below:</p>
<p>Content assist provides code completion in the body of a method
or a function. For the current project (and any referenced projects) a list is
displayed of the elements that begin with the letter combination you entered, and
the relevance of each proposal is determined in the following order:</p>
<ul>
<li>Global variables</li>
<li>Global functions</li>
<li>Global enumerations</li>
<li>Global structs</li>
<li>Global classes</li>
<li>Global unions</li>
<li>Global macros</li>
<li>Fields</li>
<li>Variables</li>
<li>Methods</li>
<li>Functions</li>
<li>Classes</li>
<li>Structs</li>
<li>Unions</li>
<li>Namespaces</li>
<li>Enumerations</li>
</ul>
You trigger the Code completion feature when you call Content Assist (such as when you type <tt>Ctrl+Space</tt>), but you alsow invoke it when you type
&quot<b>.</b>&quot, &quot<b>-></b>&quot or &quot<b>::</b>&quot.</p>
<img src="../images/contentAssist_example.gif" border="0" width="598" height="544" alt="C++ example showing Code Assist popup">
<p>You can view the signature of each item on the list in a pop-up by pointing
to it. You can then select an
item in the list to insert it directly into your code. Newly created
elements in your current or referenced project(s) must be saved before they will
appear in the Content Assist list.</p>
<h2>Code Templates</h2>
<h2>Code templates</h2>
<p>Code templates are frequently used sections of code that you can create and
then save for reuse. The Content Assist feature also provides access to code
templates. Code Template names beginning
with the letter combination you entered are displayed in a list in alphabetical
order followed by code elements. You can then select a code template from the list and
it is inserted directly
into your code.</p>
<p>You can create and save code templates for frequently used sections of code. The Content Assist feature also provides quick access to code
templates.</p>
<p>
<img border="0" src="../images/editor_c_codetemplates_use.gif" width="483" height="333"></p>
<p>When you enter a letter combination in the C/C++ editor, and type <tt>CTRL+SPACE</tt> (or right-click and click <b>Content Assist</b>), a
list of code elements and code templates that start with the letter combination that you typed is displayed.</p>
<p>For example, the code template <samp>do - while statement</samp> contains the code:</p>
<p>You can then select a code template from the list and it is inserted directly into your code.</p>
<p><samp>do {<br>
${cursor}<br>
} while (${condition});</samp></p>
<p><img border="0" src="../images/editor_c_codetemplates_use.gif" width="483" height="333" alt="C++ example showing Code Assist popup"></p>
<p> When you select the <samp>do</samp> code template from the list, the
following is inserted in your code:</p>
<p>For example, the code template <samp>do while statement</samp> contains the following code:</p>
<p> <samp>
do {<br>
} while (condition);</samp></p>
<p><pre>do {
${cursor}
} while (${condition});</pre></p>
<p>A selection of common code templates are already defined. These can be browsed in
<b>Window &gt; Preferences &gt; C/C++ &gt; Code Templates</b>.</p>
<p> When you select the <samp>do</samp> code template from the list, you insert the following code:</p>
<p>You can create, import and, export code templates.</p>
<p><pre>do {
} while (condition);</pre></p>
<p>If the completion engine finds only one proposal in your templates, that proposal is inserted at the current cursor position.
For example if you create a new CPP file and type <tt>mai+CTRL+SPACE</tt> the following code is inserted at the cursor location:</p>
<p><pre>int
main(int argc, char **argv) {
}</pre></p>
<p><img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
<br>

38
doc/org.eclipse.cdt.doc.user/concepts/cdt_c_over_cdt.htm
View file

@ -1,27 +1,21 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html lang="en">
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CDT overview</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>CDT overview</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head>
<body>
<h1>CDT overview</h1>
<p>The C/C++ development tool (CDT) is a set of Eclipse plugins that provide a
C/C++ development environment on the Eclipse platform. For more information on
<p>The C/C++ Development Toolkit (CDT) is a set of Eclipse plugins that provide
C and C++ extensions to the Eclipse workbench. For more information about
Eclipse, see <b>Workbench User Guide &gt; Concepts &gt; Workbench</b>.</p>
<p>The CDT provides a graphical interface for many of the same tools
that you use from the command line. The CDT communicates with, and interprets
messages from, utilities that include:</p>
<p>The CDT provides a C/C++ IDE that simplifies many of the same tools that
you can use from the command line. The CDT can also communicate with many external
utilities and intepret their responses, such as:</p>
<ul>
<li>Build (such as make).</li>
<li>Compile (such as gcc). For more information, see
@ -30,7 +24,7 @@ messages from, utilities that include:</p>
<a href="http://sources.redhat.com/gdb/">http://sources.redhat.com/gdb/</a>.</li>
</ul>
<p>The CDT is launched as the C/C++ perspective of the Eclipse workbench. The
<p>The CDT opens as the C/C++ perspective of the Eclipse workbench. The
C/C++ perspective consists of an editor and the following
views:</p>
<ul>
@ -47,7 +41,7 @@ views:</p>
<h3>Additional information</h3>
<p>Refer to <a href="http://www.eclipse.org/cdt/">http://www.eclipse.org/cdt/</a>
for additional information on the CDT project, including:</p>
for additional information about the CDT project, including the following resources:</p>
<ul>
<li>&nbsp;CDT newsgroups: Ask questions on how to use the CDT.</li>
@ -61,12 +55,16 @@ for additional information on the CDT project, including:</p>
<h3>CDT updates</h3>
<p>The <b>Install/Update</b> perspective provides information on your current
Eclipse installation and lets you manage updates. For more information, see <b>Workbench User Guide &gt; Tasks &gt; Updating
<p>The <b>Install/Update</b> perspective provides information about your current
Eclipse installation and provides the framework to manage your updates. For more information, see <b>Workbench User Guide &gt; Tasks &gt; Updating
features with the update manager</b>.</p>
<p>To view a list of the updates available for the toolsets that you have
<p>To view a list of the updates available for the toolsets that you
installed, click <b>Help &gt; Software Updates &gt; New Updates</b> .</p>
<h3>License</h3>
<p>The CDT is an open source project and is licensed under the <a href="http://www.eclipse.org/legal/cpl-v05.html">Common Public License</a>.
<p>
<img border="0" src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
<br>

51
doc/org.eclipse.cdt.doc.user/concepts/cdt_c_projects.htm
View file

@ -2,20 +2,17 @@
<html lang="en">
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CDT projects</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>CDT projects</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head>
<body>
<h1>CDT projects</h1>
<p>Before you do any work in the CDT, you must create a project to store your
source code, makefiles, binaries and related files. C/C++ projects are displayed
<p>Before you can work in the CDT, you must create a project to store your
source code, makefiles, binaries, and related files. C/C++ projects are displayed
in the C/C++ Projects view.</p>
<p><b>Tip:</b> Nested projects are not supported. Each project must be organized as a
@ -35,22 +32,22 @@ see <a href="../tasks/cdt_t_proj_ref.htm">Selecting referenced projects</a>.</p>
<p>You can create a standard make C or C++ project or a managed make C or C++
project.</p>
<h3>Standard Make C or C++ project</h3>
<h3>Standard make C or C++ project</h3>
<p>You need to create a makefile in order to build your project or use an
existing makefile.</p>
<h3>Managed Make C or C++ project</h3>
<h3>Managed make C or C++ project</h3>
<p>A managed make project generates the makefile for you. In addition, the
<p>A managed make project generates the makefile for you automatically. In addition, the
files module.dep and module.mk are created for every project sub-directory.
These files are required for your managed make project to successfully build.</p>
These files are required for your managed make projects to build successfully.</p>
<h3>How the CDT associates project natures</h3>
<p>Projects are assigned natures and tags that identify the
properties of each project. The CDT uses natures to identify what can and cannot be done with each project. The
CDT also uses natures to filter out projects that are contextually
CDT also uses natures to filter projects that are contextually
irrelevant; for example, non-library projects from a list of library projects.</p>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="56%">
@ -78,29 +75,23 @@ irrelevant; for example, non-library projects from a list of library projects.</
<h2>Project conversion</h2>
<p>You can convert a C project to a C++ project and vice versa. An example of
when this may be useful is if you create a C project, your requirements change during the course of
the development, and you
need to continue coding in C++. Since the initial project was coded in C,
the parser will not recognize certain semantics such as &quot;class&quot;, or keywords
such as
&quot;public&quot;, &quot;private&quot;, and&nbsp; &quot;template&quot;. You need to create a C++ project to
make the parser and other tools aware of the language change. You can simply
convert your C project to a C++ project rather than creating a new C++ project, copying your project files over and resolving source control issues.</p>
<p>You can convert projects can be converted from C to C++ (or from C++ to C). If, for
example, your requirements change and you must convert an existing C project to C++,
you can do this without recreating the project. The CDT converts your project files and
resolves any source control issues.</p>
<h2>A few notes about projects</h2>
<ul>
<li>When you create a file within a project, a record (local
history) is created of every time that you modify the file and how you modify it.
For more information about local history, see <b>Workbench User Guide &gt; Reference &gt; User interface
<li>When you create a file within a project, a record (local history) of
every change is created. For more information about local history, see
<b>Workbench User Guide &gt; Reference &gt; User interface
information &gt; Development environment &gt; Local history</b>.</li>
<li>Spaces in projects and filenames can cause problems with some
tools, such as the make utility or the compiler.</li>
<li>Be careful when using case alone to between distinguish files and projects. UNIX-based
operating system
filenames are case-sensitive, but Windows filenames are not. Therefore, Hello.c and
hello.c overwrite each other in Windows, but are separate files in UNIX.</li>
<li>Be careful when you use only case to distinguish files and projects. UNIX-based
operating system file names are case sensitive, but Windows filenames are not. Therefore, Hello.c and
hello.c are separate files in UNIX but overwrite each other in Windows.</li>
</ul>

96
doc/org.eclipse.cdt.doc.user/concepts/cdt_c_whatsnew.htm
View file

@ -2,18 +2,90 @@
<html lang="en">
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>What's new</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>What's new</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head>
<body>
<h1>What's new</h1>
<p style="margin-bottom: 0in;">&nbsp; </p>
<table width="100%" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td width="60%">
<p><h1>What's new in the CDT?</h1></p>
</td>
<td width="40%">
<p><img src="http://dev.eclipse.org/images/Idea.jpg"
name="Graphic1" align="middle" hspace="50" width="120" height="86"
border="0"></p>
</td>
</tr>
</tbody>
<table width="100%" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td colspan="2" valign="top" bgcolor="#0080c0">
<p align="left"><b><font color="#ffffff" face="Arial, Helvetica">What's New in M8</font></b></p>
</td>
</tr>
</tbody>
</table>
<h3>Enhanced Performance</h3>
<p>Parser performance enhancements were added.</p>
<p>Builds can now be performed in the background.</p>
<p>Searches can now be performed in the background.</p>
<h3>Improved Managed Make</h3>
<p>You can now set the compiler command for managed projects.</p>
<h3>Improved Standard Make</h3>
<p>Standard Make now parses response from Make command to populate paths and symbols.</p>
<h3>Support for GNU</h3>
<p>Now supports some of the GNU extensions to the ANSI specification.</p>
<h3>Improved View and Browsing Features</h3>
<p>You can now open Include files from the Outline View.</p>
<p>Rename Refactoring is now supported from Projects, Outline and Editor views.
<p>You can now perform selection searches from the C/C++ Editor</p>
<h3>Improved Search</h3>
<p>Search now supports external files referenced using <tt>#include</tt>.</p>
<table width="100%" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td colspan="2" valign="top" bgcolor="#0080c0">
<p align="left"><b><font color="#ffffff" face="Arial, Helvetica">What's New Since 1.2</font></b></p>
</td>
</tr>
</tbody>
</table>
<h3>Makefile Outline View</h3>
<p>You can now browse the structure of your Makefile in Outline View.</p>
<h3>Content Assist Enhancements</h3>
<p>Content Assist now produces proposals from class members.</p>
<p>Content Assist now supports C++.</p>
<table width="100%" border="0" cellpadding="2" cellspacing="2">
<tbody>
<tr>
<td colspan="2" valign="top" bgcolor="#0080c0">
<p align="left"><b><font color="#ffffff" face="Arial, Helvetica">What's New in 1.2</font></b></p>
</td>
</tr>
</tbody>
</table>
<p>Find out what's new in CDT 1.2.</p>
<h2>C/C++ Search</h2>
@ -32,10 +104,10 @@ informational messages from compilers, linkers, etc... during a build.</p>
<p>Support changing/enabling default make targets for each workbench build type.
New default build location setting.</p>
<h4>Make project options</h4>
<p>New user settable error parser configuration. User can enable/disable and
change older of the build error parsers used during the project build.</p>
<p>New Includes paths and Preprocessor symbols entry to allow proper indexing
and search of the project.</p>
<p>You can now make changes the Error Parser Configuration. You can change the order in which error parsers are applied or disable them entirely.</p>
<p>You can also specify which paths to include during a Make and customize preprocessor symbols to ensure proper indexing and search capabilities.</p>
<p>Notes:<br>
There are a number of "build error parsers" (the things that turn compiler error messages into objects that we can put into the error lists). If one parser cannot figure out what the message means, then the system moves to the next one in the list.</p>
<h4>Make target</h4>
<p>Make targets now support Stop on error build option and ability to change the
default build command.</p>

12
doc/org.eclipse.cdt.doc.user/concepts/cdt_o_concepts.htm
View file

@ -2,12 +2,10 @@
<html lang="en">
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Concepts</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>Concepts</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head>
<body>
@ -37,7 +35,7 @@ complete a specific task.</p>
</tr>
<tr>
<td align="left" width="334">C/C++ projects</td>
<td align="left" width="110"><a href="cdt_c_projects.htm">CDT projects</a></td>
<td align="left" width="110"><a href="cdt_o_projects.htm">CDT projects</a></td>
</tr>
<tr>
<td align="left" width="334">Code aids</td>

28
doc/org.eclipse.cdt.doc.user/concepts/cdt_o_home.htm
View file

@ -2,38 +2,34 @@
<html lang="en">
<head>
<meta http-equiv="Content-Language" content="en-us">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="ProgId" content="FrontPage.Editor.Document">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>C/C++ Development User Guide</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++ Development User Guide</title>
<link rel="stylesheet" type="text/css" href="../help.css">
</head>
<body>
<h1>C/C++ Development User Guide</h1>
<p>The C/C++ Development User Guide provides all of the information you need to
that you need get started.</p>
<h1>C/C++ Development Toolkit User Guide</h1>
<p>This guide provides instructions for using the C/C++ Development Toolkit (CDT) in the workbench.</p>
<table border="1" cellpadding="5" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="540">
<tr>
<th align="left" valign="bottom" width="217">To</th>
<th align="left" valign="bottom" width="217">For</th>
<th align="left" width="300">See</th>
</tr>
<tr>
<td align="left" width="217">Learn C/C++ Development Tool (CDT) basics</td>
<td align="left" width="300"><a href="../tasks/cdt_o_tutorial.htm">Tutorial</a></td>
<td align="left" width="217">CDT basics</td>
<td align="left" width="300"><a href="../getting_started/cdt_o_tutorial.htm">Tutorial</a></td>
</tr>
<tr>
<td align="left" width="217">Learn CDT background information</td>
<td align="left" width="217">CDT background information</td>
<td align="left" width="300"><a href="cdt_o_concepts.htm">Concepts</a></td>
</tr>
<tr>
<td align="left" width="217">Get step-by-step instructions to use the CDT</td>
<td align="left" width="217">Step-by-step instructions to use the CDT</td>
<td align="left" width="300"><a href="../tasks/cdt_o_tasks.htm">Tasks</a></td>
</tr>
<tr>
<td align="left" width="217">Learn about CDT icons, views and dialog boxes</td>
<td align="left" width="217">Information about CDT icons, views, and windows</td>
<td align="left" width="300"><a href="../reference/cdt_o_ref.htm">Reference</a></td>
</tr>
</table>

3
doc/org.eclipse.cdt.doc.user/help.css
View file

@ -17,9 +17,10 @@ h1 { font-size: 18pt; margin-top: 5; margin-bottom: 1 }
h2 { font-size: 14pt; margin-top: 25; margin-bottom: 3 }
h3 { font-size: 11pt; margin-top: 20; margin-bottom: 3 }
h4 { font-size: 10pt; margin-top: 20; margin-bottom: 3; font-style: italic }
p { margin-top: 10px; margin-bottom: 10px }
p { font-size: 10pt; }
pre { margin-left: 6; font-size: 9pt }
a:link { color: #006699 }
a:visited { color: #996699 }
a:hover { color: #006699 }