Skip to main content
summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEmanuel Graf2011-04-14 04:20:42 -0400
committerEmanuel Graf2011-04-14 04:20:42 -0400
commit32897bacd5d0182813b0e549bd7c345205c3fdbd (patch)
treec6045cc38712a55fa0f1668171af21761e891fee /doc
parent536ce267eedc3dba6a84cbc45acb02703010eb83 (diff)
downloadorg.eclipse.cdt-32897bacd5d0182813b0e549bd7c345205c3fdbd.tar.gz
org.eclipse.cdt-32897bacd5d0182813b0e549bd7c345205c3fdbd.tar.xz
org.eclipse.cdt-32897bacd5d0182813b0e549bd7c345205c3fdbd.zip
Bug 342524: Toggle Refactoring: Create user documentation
https://bugs.eclipse.org/bugs/show_bug.cgi?id=342524
Diffstat (limited to 'doc')
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_member.pngbin0 -> 14362 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection.pngbin0 -> 10768 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_o_tasks.htm2
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_o_write_code.htm3
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_t_refactoring.htm25
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_t_rename.htm39
-rw-r--r--doc/org.eclipse.cdt.doc.user/tasks/cdt_t_toggle.htm36
-rw-r--r--doc/org.eclipse.cdt.doc.user/topics_Tasks.xml7
8 files changed, 91 insertions, 21 deletions
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_member.png b/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_member.png
new file mode 100644
index 0000000000..7c594e1600
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_member.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection.png b/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection.png
new file mode 100644
index 0000000000..5b1c394d3c
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_tasks.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_tasks.htm
index 3a65262ea3..e2396de0c7 100644
--- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_tasks.htm
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_tasks.htm
@@ -35,6 +35,8 @@
<img src="../images/trans.gif" width="50" height="1" alt=""><a style="text-decoration:none" href="cdt_t_shift_code.htm">Shifting lines of code to the right or left</a><br>
<img src="../images/trans.gif" width="50" height="1" alt=""><a style="text-decoration:none" href="cdt_t_open_declarations.htm">Navigating to C/C++ declarations</a><br>
<img src="../images/trans.gif" width="50" height="1" alt=""><a style="text-decoration:none" href="cdt_t_refactoring.htm">Refactoring</a><br>
+ <img src="../images/trans.gif" width="75" height="1" alt=""><a style="text-decoration:none" href="cdt_t_rename.htm">Rename</a><br>
+ <img src="../images/trans.gif" width="75" height="1" alt=""><a style="text-decoration:none" href="cdt_t_toggle.htm">Toggle Function Definition</a><br>
<img src="../images/trans.gif" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_o_build_task.htm">Building projects</a><br>
<img src="../images/trans.gif" width="50" height="1" alt=""><a style="text-decoration:none" href="cdt_t_proj_rename.htm">Renaming a project</a><br>
<img src="../images/trans.gif" width="50" height="1" alt=""><a style="text-decoration:none" href="../reference/cdt_u_prop_general_pns_ref.htm">Selecting referenced projects</a><br>
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_write_code.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_write_code.htm
index 2068fcef1d..79c57a06b5 100644
--- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_write_code.htm
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_o_write_code.htm
@@ -23,7 +23,8 @@
<img src="../images/trans.gif" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_t_sel_search.htm">Selection Searching for C/C++ elements</a><br>
<img src="../images/trans.gif" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_t_open_declarations.htm">Navigating to C/C++ declarations</a><br>
<img src="../images/trans.gif" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_t_refactoring.htm">Refactoring</a><br>
-
+ <img src="../images/trans.gif" width="50" height="1" alt=""><a style="text-decoration:none" href="cdt_t_rename.htm">Rename</a><br>
+ <img src="../images/trans.gif" width="50" height="1" alt=""><a style="text-decoration:none" href="cdt_t_toggle.htm">Toggle Function Definition</a><br>
<p><img src="../images/ng00_04a.gif" ALT="QNX Copyright Statement" ></p>
</body>
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_refactoring.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_refactoring.htm
index f8f533597e..a5bc99f99a 100644
--- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_refactoring.htm
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_refactoring.htm
@@ -12,25 +12,12 @@
<h1 role="main">Refactoring</h1>
-<p>Use the C/C++ Projects, Outline, or the Editor view <strong>Refactor &gt; Rename</strong> context menu to refactor class &amp; type names, methods, function &amp; member names.</p>
-
-<p>To refactor an object select the object, right click and select <strong>Refactor &gt; Rename...</strong></p>
-<p> <img src="../images/cdt_refactor.png" alt="Editor View showing Refactor option" ></p>
-
- The refactoring engine will rename all instances of the object in all referenced files. You can Undo refactoring by right clicking a second time and selecting <strong>Refactor &gt; Undo</strong></p>
- <p> <img src="../images/cdt_refactor_undo.png" alt="Editor View showing Refactor Undo option" ></p>
-
-<p><img src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
-<br>
-<a href="../concepts/cdt_c_open_declarations.htm">Open Declaration</a><br>
-<a href="../concepts/cdt_c_projects.htm">CDT Projects</a><br>
-<a href="../concepts/cdt_c_search.htm">C/C++ search</a></p>
-<p><img src="../images/ngtasks.gif" ALT="Related tasks" width="143" height="21">
-<br>
-<a href="cdt_t_search.htm">Searching for C/C++ elements</a></p>
-<p><img src="../images/ngref.gif" ALT="Related reference" width="143" height="21">
-<br>
-<a href="../reference/cdt_u_search.htm">C/C++ search page, Search dialog box</a></p>
+<p>The following topics provide information about refactoring:</p>
+ <img src="../images/trans.gif" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_t_rename.htm">Rename Refactoring</a><br>
+ <img src="../images/trans.gif" width="25" height="1" alt=""><a style="text-decoration:none" href="cdt_t_toggle.htm">Toggle Function Refactoring</a><br>
+
+
+<p>
<img src="../images/ng00_07.gif" ALT="IBM Copyright Statement" >
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_rename.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_rename.htm
new file mode 100644
index 0000000000..691011d8b5
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_rename.htm
@@ -0,0 +1,39 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html lang="en">
+
+<head>
+<meta http-equiv="Content-Language" content="en-us">
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Rename Refactoring</title>
+<link rel="stylesheet" type="text/css" href="../help.css">
+</head>
+
+<body>
+
+<h1 role="main">Rename Refactoring</h1>
+
+<p>Use the C/C++ Projects, Outline, or the Editor view <strong>Refactor &gt; Rename</strong> context menu to refactor class &amp; type names, methods, function &amp; member names.</p>
+
+<p>To refactor an object select the object, right click and select <strong>Refactor &gt; Rename...</strong></p>
+<p> <img src="../images/cdt_refactor.png" alt="Editor View showing Refactor option" ></p>
+
+ The refactoring engine will rename all instances of the object in all referenced files. You can Undo refactoring by right clicking a second time and selecting <strong>Refactor &gt; Undo</strong></p>
+ <p> <img src="../images/cdt_refactor_undo.png" alt="Editor View showing Refactor Undo option" ></p>
+
+<p><img src="../images/ngconcepts.gif" ALT="Related concepts" width="143" height="21">
+<br>
+<a href="../concepts/cdt_c_open_declarations.htm">Open Declaration</a><br>
+<a href="../concepts/cdt_c_projects.htm">CDT Projects</a><br>
+<a href="../concepts/cdt_c_search.htm">C/C++ search</a></p>
+<p><img src="../images/ngtasks.gif" ALT="Related tasks" width="143" height="21">
+<br>
+<a href="cdt_t_search.htm">Searching for C/C++ elements</a></p>
+<p><img src="../images/ngref.gif" ALT="Related reference" width="143" height="21">
+<br>
+<a href="../reference/cdt_u_search.htm">C/C++ search page, Search dialog box</a></p>
+
+<img src="../images/ng00_07.gif" ALT="IBM Copyright Statement" >
+
+</body>
+
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_toggle.htm b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_toggle.htm
new file mode 100644
index 0000000000..2b2434f57e
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_toggle.htm
@@ -0,0 +1,36 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html lang="en">
+
+<head>
+<meta http-equiv="Content-Language" content="en-us">
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Toggle Function Definition Refactoring</title>
+<link rel="stylesheet" type="text/css" href="../help.css">
+</head>
+
+<body>
+
+<h1 role="main">Toggle Function Definition</h1>
+
+<p>Toggle Function Definition moves a function definition inside an Eclipse CDT source editor from one
+position to another and preserves correctness.</p>
+
+<p>Toggling is available whenever the cursor is inside a function declaration
+or definition. Any selection between the first and the last character of
+the function definition (without comments) is considered valid for toggling.</p>
+<p><img alt="Selection" src="../images/cdt_t_toggle_selection.png" title="Valid selection region"><br/>Valid selection region</p>
+
+<h2>Toggle free functions</h2>
+<p>The refactoring moves free functions from an implementation file to a header file with the same name and back.
+ If the header file does not exist the file is created.</p>
+
+<h2>Toggle member functions</h2>
+ <p>The function definition of a member function can by moved from the class declaration in the header file to an inline definition
+ in the header file to the implementation file and back to the class definition.</p>
+ <p><img alt="Toggle Member Function Definition" src="../images/cdt_t_toggle_member.png"></p>
+
+<img src="../images/ng00_07.gif" ALT="IBM Copyright Statement" >
+
+</body>
+
+</html>
diff --git a/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml b/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml
index 5ebe2782b8..b7a411204c 100644
--- a/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml
+++ b/doc/org.eclipse.cdt.doc.user/topics_Tasks.xml
@@ -25,7 +25,12 @@
</topic>
<topic label="Shift lines of code to the left or right" href="tasks/cdt_t_shift_code.htm"/>
<topic label="Navigate to C/C++ declarations by name" href="tasks/cdt_t_open_declarations.htm"/>
- <topic label="Refactoring" href="tasks/cdt_t_refactoring.htm"/>
+ <topic href="tasks/cdt_t_refactoring.htm" label="Refactoring">
+ <topic href="tasks/cdt_t_rename.htm" label="Rename">
+ </topic>
+ <topic href="tasks/cdt_t_toggle.htm" label="Toggle Function Definition">
+ </topic>
+ </topic>
</topic>
<topic label="Building projects" href="tasks/cdt_o_build_task.htm">
<topic label="Renaming a project" href="tasks/cdt_t_proj_rename.htm"/>

Back to the top