Skip to main content
path: root/doc
diff options
authorJesse Weinstein2013-02-15 21:19:13 -0500
committerSergey Prigogin2013-02-16 14:21:33 -0500
commit9b764dddbd35df9f828a073e61bbb566c86b54e2 (patch)
tree63094a4cd71611e69b985dce0b39c6e54e117c5a /doc
parentc5f65f37220a8cbd993a5fd270f1ab966a9cc19d (diff)
Bug 400226: updated Toggle Function Definition docs
Change-Id: Ie7c579d40e64ea8e0c4d6e7354db8a12c480f964 Reviewed-on: Reviewed-by: Sergey Prigogin <> IP-Clean: Sergey Prigogin <> Tested-by: Sergey Prigogin <>
Diffstat (limited to 'doc')
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_member.pngbin14362 -> 0 bytes
-rwxr-xr-x[-rw-r--r--]doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection.pngbin10768 -> 35657 bytes
-rwxr-xr-xdoc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection2.pngbin0 -> 12526 bytes
-rwxr-xr-xdoc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection3.pngbin0 -> 5316 bytes
5 files changed, 33 insertions, 26 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
deleted file mode 100644
index 7c594e1600..0000000000
--- a/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_member.png
+++ /dev/null
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
index 5b1c394d3c..5f68cbc0ae 100644..100755
--- 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
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection2.png b/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection2.png
new file mode 100755
index 0000000000..1831f1f276
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection2.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection3.png b/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection3.png
new file mode 100755
index 0000000000..00a6913ded
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_t_toggle_selection3.png
Binary files differ
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
index 1571d6a35d..a62fd373ff 100644..100755
--- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_toggle.htm
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_toggle.htm
@@ -1,36 +1,43 @@
<html lang="en">
<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">
-<div role="main"><h1>Toggle Function Definition</h1>
-<p>Toggle Function Definition moves a function definition inside an C/C++ 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" >
+ <div role="main">
+ <h1>Toggle Function Definition</h1>
+ <p>
+ Use the <strong>Refactor &gt; Toggle Function Definition</strong>
+ command to toggle the location where a function is defined.
+ </p>
+ <p>
+ In an Editor window, place the cursor inside a function declaration
+ or definition, then run <strong>Refactor &gt; Toggle
+ Function Definition</strong> from the context menu. Any cursor position
+ between the first and the last characters of the function definition
+ (but not including comments preceding the function) will cause that
+ function to be selected for the refactoring.
+ </p>
+ <p>
+ <img alt="" src="../images/cdt_t_toggle_selection.png">
+ </p>
+ <p>This refactoring switches a function definition from a header
+ file to a correspondingly-named implementation file. If the necessary
+ file does not exist, it will be created (after a confirmation
+ dialog).</p>
+ <p>
+ <img alt="" src="../images/cdt_t_toggle_selection2.png">
+ </p>
+ <p>For methods, it can also switch the method from being defined
+ within its parent class declaration to being defined using an inline
+ definition in the same header file.</p>
+ <p>
+ <img alt="" src="../images/cdt_t_toggle_selection3.png">
+ </p>
+ <img src="../images/ng00_07.gif" ALT="IBM Copyright Statement">
+ </div>

Back to the top