Skip to main content
path: root/doc
diff options
authorJesse Weinstein2013-02-15 15:39:55 -0500
committerSergey Prigogin2013-02-16 14:19:22 -0500
commitc5f65f37220a8cbd993a5fd270f1ab966a9cc19d (patch)
tree2335d5144d16e37601c7383ffc07a21ffb380e60 /doc
parentee70160c98e98591e789175ab95cd3e884a00517 (diff)
Bug 400226: updated Rename refactoring docs
Change-Id: Ic5d2ecc39fa6dd97b8640b5170adcac59450be3e Reviewed-on: Reviewed-by: Sergey Prigogin <> IP-Clean: Sergey Prigogin <> Tested-by: Sergey Prigogin <>
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/org.eclipse.cdt.doc.user/images/cdt_inline_rename.pngbin0 -> 10406 bytes
-rw-r--r--doc/org.eclipse.cdt.doc.user/images/cdt_refactor.pngbin25212 -> 56633 bytes
-rwxr-xr-xdoc/org.eclipse.cdt.doc.user/images/cdt_rename_dialog.pngbin0 -> 27868 bytes
4 files changed, 45 insertions, 29 deletions
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_inline_rename.png b/doc/org.eclipse.cdt.doc.user/images/cdt_inline_rename.png
new file mode 100755
index 0000000000..44047e88db
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_inline_rename.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_refactor.png b/doc/org.eclipse.cdt.doc.user/images/cdt_refactor.png
index 1489754972..22a4375c9c 100644
--- a/doc/org.eclipse.cdt.doc.user/images/cdt_refactor.png
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_refactor.png
Binary files differ
diff --git a/doc/org.eclipse.cdt.doc.user/images/cdt_rename_dialog.png b/doc/org.eclipse.cdt.doc.user/images/cdt_rename_dialog.png
new file mode 100755
index 0000000000..4be0a7d5ff
--- /dev/null
+++ b/doc/org.eclipse.cdt.doc.user/images/cdt_rename_dialog.png
Binary files differ
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
index adbc2c2153..2f96212125 100644..100755
--- a/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_rename.htm
+++ b/doc/org.eclipse.cdt.doc.user/tasks/cdt_t_rename.htm
@@ -1,39 +1,55 @@
<html lang="en">
<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">
-<div role="main"><h1>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">
-<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">
-<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">
-<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" >
+ <div role="main">
+ <h1>Rename Refactoring</h1>
+ <p>
+ Use the <strong>Refactor &gt; Rename</strong> command to rename
+ variables, functions, classes, methods, fields or typedefs.
+ </p>
+ <p>
+ In an Editor window, select an item and run <strong>Refactor
+ &gt; Rename...</strong> from the context menu.
+ </p>
+ <p>
+ <img src="../images/cdt_inline_rename.png"
+ alt="Example of inline renaming.">
+ </p>
+ <p>All uses of the name are highlighted, and updated in real time
+ as you type. If you want to view the preview, or change any options,
+ simply click on the triangle, or press the keyboard shortcut again.
+ Otherwise, the options are the same as the last time a rename
+ refactoring was done.</p>
+ <p>When you hit Enter, all the item's declarations, definitions
+ and references will be changed to use the new name. The standard Undo
+ command can be used to revert the changes, if necessary.</p>
+ <p>The options can be set using a dialog box, where you can
+ specify the new name, and set various options affecting how hard to
+ look for uses of the name that should be updated. From there you can
+ also view the Preview of the changes that will be made by the
+ refactoring.</p>
+ <p>
+ <img src="../images/cdt_rename_dialog.png" alt="Rename dialog box">
+ </p>
+ <p>Items to be renamed can also be selected from the Project
+ Explorer window, although inline renaming is not available in this
+ case, so the dialog box comes up immediately.</p>
+ <p>
+ <img src="../images/cdt_refactor.png"
+ alt="Project Explorer context menu Refactor &gt; Rename command">
+ </p>
+ <p>
+ <img src="../images/ngref.gif" alt="Related reference" width="143"
+ height="21"> <br> <a
+ href="../reference/cdt_u_m_refactor.htm">Refactor Menu actions</a>
+ </p>
+ <img src="../images/ng00_07.gif" alt="IBM Copyright Statement">
+ </div>

Back to the top