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

Bug 400226: updated Rename refactoring docs

Browse source 
Change-Id: Ic5d2ecc39fa6dd97b8640b5170adcac59450be3e
Reviewed-on: https://git.eclipse.org/r/10402
Reviewed-by: Sergey Prigogin <eclipse.sprigogin@gmail.com>
IP-Clean: Sergey Prigogin <eclipse.sprigogin@gmail.com>
Tested-by: Sergey Prigogin <eclipse.sprigogin@gmail.com>
This commit is contained in:
Jesse Weinstein 2013-02-15 15:39:55 -05:00 • committed by Sergey Prigogin
parent ee70160c98
commit c5f65f3722
4 changed files with 45 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
doc/org.eclipse.cdt.doc.user/images/cdt_inline_rename.png Executable file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 10 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/cdt_refactor.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 55 KiB

BIN
doc/org.eclipse.cdt.doc.user/images/cdt_rename_dialog.png Executable file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 27 KiB

74
doc/org.eclipse.cdt.doc.user/tasks/cdt_t_rename.htm Normal file → Executable file
View file

@ -1,39 +1,55 @@
<!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>
<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">
<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" >
</div></body>
<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>
</body>
</html>