Skip to content

Commit eec32bb

Browse files
author
Tyler Whitney
committed
update alt-text code and removed 'experimental' from images
1 parent 4a69dd6 commit eec32bb

11 files changed

Lines changed: 37 additions & 44 deletions

docs/ide/cpp-linter-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ When you change the check severity level, it changes how the problem is shown in
4040

4141
::: moniker range=">=msvc-170"
4242

43-
![Screenshot showing the C plus plus linter configuration with options such as warning on accidental assignment, uninitialized local variable, and more.](../ide/media/linter-settings.png)
43+
![Screenshot of the linter configuration window with options such as warning on accidental assignment, uninitialized local variable, and more.](../ide/media/linter-settings.png)
4444

4545
(The presentation in Visual Studio 2019 is slightly different, but the options are similar.)
4646

docs/ide/refactoring/change-signature.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
description: "Learn more about: Change Signature"
33
title: "Change Signature"
4-
ms.date: "11/16/2016"
5-
ms.assetid: 8daaa060-7305-4035-99d2-8b460b4f4454
4+
ms.date: "09/18/2022"
65
---
76
# Change Signature
87

@@ -16,7 +15,7 @@ ms.assetid: 8daaa060-7305-4035-99d2-8b460b4f4454
1615

1716
1. Place the text or mouse cursor inside the name of the method to modify, or one of its usages:
1817

19-
![Screenshot showing highlighted code.](images/changesignature_highlight.png)
18+
![Screenshot of code with the mouse cursor on the function ChangeUserInfo.](images/changesignature_highlight.png)
2019

2120
1. Next, do one of the following:
2221
* **Keyboard**
@@ -28,7 +27,7 @@ ms.assetid: 8daaa060-7305-4035-99d2-8b460b4f4454
2827

2928
1. In the **Change Signature** dialog that pops up, you can use the buttons on the right side to change the method signature:
3029

31-
![Screenshot showing the Change Signature dialog.](images/changesignature_dialog.png)
30+
![Screenshot of the Change Signature dialog for the ChangeName() function. Parameters are listed by name, type, and associated value, if any.](images/changesignature_dialog.png)
3231

3332
| Button | Description
3433
| ------ | ---
@@ -44,7 +43,7 @@ ms.assetid: 8daaa060-7305-4035-99d2-8b460b4f4454
4443
4544
When adding or modifying a parameter, you will see the **Add Parameter** or **Edit Parameter** window.
4645

47-
![Screenshot showing the Add Modify parameter.](images/changesignature_addmodify.png)
46+
![Screenshot of the Add parameter window where you can edit or set a parameter's type, name, whether it is a default or optional.](images/changesignature_addmodify.png)
4847

4948
Here, you can do the following:
5049

@@ -60,8 +59,9 @@ ms.assetid: 8daaa060-7305-4035-99d2-8b460b4f4454
6059

6160
1. When you are finished, press the **OK** button to make the changes. Ensure that the changes you are requesting are being made appropriately. Use the checkboxes in the top half of the window to enable or disable the renaming of any item.
6261

63-
![Screenshot showing the Change Signature preview.](images/changesignature_preview.png)
62+
![Screenshot of a Change Signature preview. Everywhere the function is called is previewed so you can verify each change.](images/changesignature_preview.png)
6463

6564
1. When everything looks good, click the **Apply** button and the function will be changed in your source code.
6665

67-
![Screenshot showing the Change Signature result.](images/changesignature_result.png)
66+
![Screenshot of the resulting change. The parameters to ChangeUserInfo() are now: std::string lastName, std::string firstname, int age = -1).](images/changesignature_result.png)
67+
ß
Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
---
22
description: "Learn more about: Convert to Raw String Literal"
33
title: "Convert to Raw String Literal"
4-
ms.date: "11/16/2016"
5-
ms.assetid: fffbfee4-66ee-42ba-aeb9-df07fb702c51
4+
ms.date: "09/19/2022"
65
---
76
# Convert to Raw String Literal
87

9-
**What:** Lets you turn any string into a C++ raw string literal.
8+
**What:** Turn any string into a C++ raw string literal.
109

1110
**When:** You have a string with escaped characters which shouldn't be processed as escaped characters.
1211

13-
**Why:** You could double-escape characters, but this often leads to confusing and unreadable strings. Using raw string literals makes strings much easier to read.
12+
**Why:** You could double-escape characters, but this often leads to confusing and strings. Raw string literals makes strings much easier to read.
1413

1514
**How:**
1615

1716
1. Place text or mouse cursor over the escaped string to convert.
1817

19-
![Screenshot showing highlighted code.](images/stringliteral_highlight.png)
18+
![Screenshot of the cursor in the middle of the word quoted on the line of code that reads: auto MyString = "A \"quoted\" string".](images/stringliteral_highlight.png)
2019

2120
1. Next, do one of the following:
2221
* **Keyboard**
@@ -27,4 +26,4 @@ ms.assetid: fffbfee4-66ee-42ba-aeb9-df07fb702c51
2726

2827
1. The string will be immediately converted into a raw string literal.
2928

30-
![Raw String Literal result.](images/stringliteral_result.png)
29+
![Screenshot showing that the line of code now reads: auto myString = R"(A "quoted" string.)" The interior quotes are no longer escaped.](images/stringliteral_result.png)

docs/ide/refactoring/create-declaration-definition.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
description: "Learn more about: Create Declaration / Definition"
33
title: "Create Declaration / Definition"
4-
ms.date: "10/19/2018"
5-
ms.assetid: 6b1cdcb2-765e-4b93-8cef-92b861f64eba
4+
ms.date: "09/19/2022"
65
---
76
# Create Declaration / Definition
87

@@ -16,7 +15,7 @@ ms.assetid: 6b1cdcb2-765e-4b93-8cef-92b861f64eba
1615

1716
1. Place your text or mouse cursor over the function for which you want to create the declaration or definition.
1817

19-
![Screenshot showing highlighted code.](images/createdefinition_highlight.png)
18+
![Screenshot showing the code: void MyFunction(int x). The cursor is on MyFunction.](images/createdefinition_highlight.png)
2019

2120
1. Next, do one of the following:
2221
* **Keyboard**
@@ -26,4 +25,4 @@ ms.assetid: 6b1cdcb2-765e-4b93-8cef-92b861f64eba
2625

2726
1. The function's declaration/definition will be created in the source or header file, which you will see in a popup preview window. If the source or header file does not exist, it will also be created and placed in the project.
2827

29-
![Create Declaration / Definition result.](images/createdefinition_result.png)
28+
![Screenshot showing a popup window containing the header file Source.h with the created declaration: void MyFunction(int x);.](images/createdefinition_result.png)
Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
---
22
description: "Learn more about: Extract Function"
33
title: "Extract Function"
4-
ms.date: "11/16/2016"
5-
ms.assetid: e31d1249-9705-4511-acbd-9f6fe73bdf2d
4+
ms.date: "09/18/2022"
65
---
76
# Extract Function
87

9-
**What:** Lets you turn a fragment of code into its own function.
8+
**What:** Turn a fragment of code into its own function.
109

1110
**When:** You have a fragment of existing code in some function that needs to be called from another function.
1211

13-
**Why:** You could copy/paste that code, but that would lead to duplication. A better solution is to refactor that fragment into its own function which can be called freely by any other function.
12+
**Why:** You could copy/paste that code, but that would lead to duplication. A better solution is to refactor that fragment into its own function which can be called by any other function.
1413

1514
**How:**
1615

1716
1. Highlight the code to be extracted:
1817

19-
![Screenshot showing highlighted code.](images/extractfunction_highlight.png)
18+
![Screenshot showing the following code that is highlighted prepartory to being extracted: double area = M_PI * readious * radious;.](images/extractfunction_highlight.png)
2019

2120
1. Next, do one of the following:
2221
* **Keyboard**
@@ -29,8 +28,8 @@ ms.assetid: e31d1249-9705-4511-acbd-9f6fe73bdf2d
2928

3029
1. In the **Extract Function/Method (Experimental)** window, enter the new function name, select where you want the code to be placed, and click the **OK** button.
3130

32-
![Extract function dialog.](images/extractfunction_dialog.png)
31+
![Screenshot of the extract function dialog which takes the function name and whether to create it above or below the current function.](images/extractfunction_dialog.png)
3332

3433
1. The new function will be created where you specified, a function prototype in the corresponding header file, and the original code will be changed to call that function.
3534

36-
![Extract function result.](images/extractfunction_result.png)
35+
![Screenshot of the created function that contains the extracted code. The definition is void CalculateArea(double radius).](images/extractfunction_result.png)
10.2 KB
Loading
9.47 KB
Loading
Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
---
22
description: "Learn more about: Implement Pure Virtuals"
33
title: "Implement Pure Virtuals"
4-
ms.date: "11/16/2016"
5-
ms.assetid: ea9b4719-34a3-474a-b4ec-05b1859f80f1
4+
ms.date: "09/19/2022"
65
---
76
# Implement Pure Virtuals
87

9-
**What:** Lets you immediately generate the code required to implement all pure virtual methods in a class.
8+
**What:** Generate the code required to implement all pure virtual methods in a class.
109

1110
**When:** You want to inherit from a class with pure virtual functions.
1211

@@ -16,7 +15,7 @@ ms.assetid: ea9b4719-34a3-474a-b4ec-05b1859f80f1
1615

1716
1. Place your text or mouse cursor over the class in which you want to implement the pure virtual functions of the base class.
1817

19-
![Screenshot showing highlighted code.](images/virtuals_highlight.png)
18+
![Screenshot of a class that has two pure virtual functions named Method1 and Method2. An empty class named MyInheritedClass derives from it.](images/virtuals_highlight.png)
2019

2120
1. Next, do one of the following:
2221
* **Keyboard**
@@ -26,4 +25,4 @@ ms.assetid: ea9b4719-34a3-474a-b4ec-05b1859f80f1
2625

2726
1. The pure virtual method signatures will be created automatically, ready to be implemented.
2827

29-
![Implement Pure Virtuals result.](images/virtuals_result.png)
28+
![Screenshot of MyInheritedClass which now has 2 virtual method definitions that match the names and signatures of the declarations in the base class.](images/virtuals_result.png)
Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
---
22
description: "Learn more about: Move Definition Location"
33
title: "Move Definition Location"
4-
ms.date: "11/16/2016"
5-
ms.assetid: c6d507ac-c61e-4da2-95c8-d504b42e2520
4+
ms.date: "09/19/2022"
65
---
76
# Move Definition Location
87

9-
**What:** Lets you immediately move a function definition to the corresponding header file.
8+
**What:** Move a function definition to the corresponding header file.
109

1110
**When:** You have a function that you want to move to a header file.
1211

13-
**Why:** You could manually move the function, but this feature will move it automatically, creating the header file if required.
12+
**Why:** You could manually move the function, but this feature will move it automatically, and create the header file if required.
1413

1514
**How:**
1615

1716
1. Place your text or mouse cursor over the function for which you want to move.
1817

19-
![Screenshot showing highlighted code.](images/movedefinition_highlight.png)
18+
![Screenshot of a function, with the cursor on the function name.](images/movedefinition_highlight.png)
2019

2120
1. Next, do one of the following:
2221
* **Keyboard**
@@ -26,4 +25,4 @@ ms.assetid: c6d507ac-c61e-4da2-95c8-d504b42e2520
2625

2726
1. The function will be moved to the corresponding header file, which you will see in a popup preview window. If the header file does not exist, it will also be created and placed in the project.
2827

29-
![Create Declaration / Definition result.](images/movedefinition_result.png)
28+
![Screenshot of a pop-up window containing a header file that the function was moved to.](images/movedefinition_result.png)

docs/ide/refactoring/rename.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
---
22
description: "Learn more about: Rename"
33
title: "Rename"
4-
ms.date: "11/16/2016"
5-
ms.assetid: 64b42a88-3bd9-4399-8b96-75bceffc353b
4+
ms.date: "09/19/2022"
65
---
76
# Rename
87

9-
**What:** Lets you rename identifiers for code symbols, such as fields, local variables, methods, namespaces, properties and types.
8+
**What:** Rename identifiers for code symbols such as fields, local variables, methods, namespaces, properties and types.
109

1110
**When:** You want to safely rename something without having to find all instances, and copy/paste the new name.
1211

13-
**Why:** Copy and pasting the new name across an entire project would likely result in errors. This refactoring tool will accurately perform the renaming action.
12+
**Why:** Copy and pasting the new name across an entire project could result in errors. This feature accurately performs the rename.
1413

1514
**How:**
1615

1716
1. Highlight or place the text cursor inside the item to be renamed:
1817

19-
![Screenshot showing highlighted code.](images/rename_highlight.png)
18+
![Screenshot showing the variable r highlighted. The line reads: double r = 1.23;.](images/rename_highlight.png)
2019

2120
1. Next, do one of the following:
2221
* **Keyboard**
@@ -27,13 +26,13 @@ ms.assetid: 64b42a88-3bd9-4399-8b96-75bceffc353b
2726

2827
1. In the **Rename** window that pops up, enter the new name for the selected item and click the **Preview** button. Change the **Search scope** if you need to widen or narrow the scope of the renaming.
2928

30-
![Rename dialog.](images/rename_dialog.png)
29+
![Screenshot of the Rename dialog. It asks for the new name of the symbol and allows you to specify the scope of the changes.](images/rename_dialog.png)
3130

3231
> [!TIP]
3332
> You can skip the preview by checking the **Skip preview changes if references are all confirmed** option.
3433
3534
1. When the **Preview Changes - Rename** window appears, ensure that the changes you are requesting are being made appropriately. Use the checkboxes in the top half of the window to enable or disable the renaming of any item.
3635

37-
![Rename preview.](images/rename_preview.png)
36+
![Screenshot of the rename preview dialog which shows the proposed changes and allows you to deselect those you don't want.](images/rename_preview.png)
3837

3938
1. When everything looks good, click the **Apply** button and the item will be renamed in your source code.

0 commit comments

Comments
 (0)