Skip to content

Commit d462dd1

Browse files
authored
Merge pull request #3170 from MicrosoftDocs/master
10/29 AM Publish
2 parents 1abb9cf + 5f3d8b6 commit d462dd1

File tree

110 files changed

+669
-575
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+669
-575
lines changed

docs/code-quality/C26415.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,32 @@ ms.workload:
1616
- "multiple"
1717
---
1818
# C26415 SMART_PTR_NOT_NEEDED
19+
1920
"Smart pointer parameter is used only to access contained pointer. Use T* or T& instead."
2021

2122
**C++ Core Guidelines**:
2223
R.30: Take smart pointers as parameters only to explicitly express lifetime semantics
2324

24-
Using a smart pointer type to pass data to a function indicates that the target function needs to manage the lifetime of the contained object. However, if the function only uses the smart pointer to access the contained object and never actually calls any code which may lead to its deallocation (never affect its lifetime), there is usually no need to complicate the interface with smart pointers. A plain pointer or reference to the contained object should be preferred.
25+
Using a smart pointer type to pass data to a function indicates that the target function needs to manage the lifetime of the contained object. However, if the function only uses the smart pointer to access the contained object and never actually calls any code that may lead to its deallocation (that is, never affect its lifetime), there is usually no need to complicate the interface with smart pointers. A plain pointer or reference to the contained object is preferred.
2526

2627
## Remarks
27-
- This check is a covers majority of scenarios that also causes C26410, C26415, C26417, and C26418. It is better to cleanup SMART_PTR_NOT_NEEDED first and then switch to edge cases for shared or unique pointers. For more focused cleanup this warning can be disabled.
28-
- In addition to the standard std::unqiue_pointer and std::shared_pointer templates, this check recognizes user defined types which are likely intended to be smart pointers. Such types are expected to define the following operations:
29-
- overloaded dereference or member access operators, that are public and not marked as deleted;
30-
- public destructor which is neither deleted nor defaulted. This includes destructors which are explicitly defined empty.
31-
- Interpretation of the operations that can affect lifetime of contained objects is quite broad and includes:
32-
- any function which accepts pointer or reference parameter to a non-constant smart pointer;
33-
- copy or move constructors or assignment operators;
34-
- non-constant functions.
35-
## Example
36-
cumbersome lifetime management
28+
29+
This check covers a majority of scenarios that also cause C26410, C26415, C26417, and C26418. It is better to clean up SMART_PTR_NOT_NEEDED first and then switch to edge cases for shared or unique pointers. For more focused cleanup, this warning can be disabled.
30+
31+
In addition to the standard std::unqiue_pointer and std::shared_pointer templates, this check recognizes user-defined types that are likely intended to be smart pointers. Such types are expected to define the following operations:
32+
33+
- Overloaded dereference or member access operators that are public and not marked as deleted.
34+
- Public destructor that's not deleted or defaulted. This includes destructors that are explicitly defined empty.
35+
36+
Interpretation of the operations that can affect the lifetime of contained objects is broad and includes:
37+
38+
- Any function that accepts a pointer or reference parameter to a non-constant smart pointer
39+
- Copy or move constructors or assignment operators
40+
- Non-constant functions
41+
42+
## Example
43+
44+
Cumbersome lifetime management.
3745

3846
```cpp
3947
bool set_initial_message(
@@ -57,7 +65,8 @@ void pass_message(const message_info &info)
5765
```
5866
5967
## Example
60-
cumbersome lifetime management - reworked
68+
69+
Cumbersome lifetime management - reworked.
6170
6271
```cpp
6372
void set_initial_message(std::shared_ptr<message> m) noexcept
@@ -72,4 +81,4 @@ void pass_message(const message_info &info)
7281
set_initial_message(m);
7382
// ...
7483
}
75-
```
84+
```

docs/data-tools/create-a-windows-forms-user-control-that-supports-simple-data-binding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ For simple controls that support databinding, implement the <xref:System.Compone
116116

117117
## Create a data source from your database
118118

119-
This step uses the **Data Source Configuration**wizard to create a data source based on the `Customers` table in the Northwind sample database. You must have access to the Northwind sample database to create the connection. For information on setting up the Northwind sample database, see [How to: Install sample databases](../data-tools/installing-database-systems-tools-and-samples.md).
119+
This step uses the **Data Source Configuration** wizard to create a data source based on the `Customers` table in the Northwind sample database. You must have access to the Northwind sample database to create the connection. For information on setting up the Northwind sample database, see [How to: Install sample databases](../data-tools/installing-database-systems-tools-and-samples.md).
120120

121121
1. On the **Data** menu, click **Show Data Sources**.
122122

docs/data-tools/save-data-to-a-database-multiple-tables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ This walkthrough uses SQL Server Express LocalDB and the Northwind sample databa
8080

8181
1. On the **Data** menu, select **Show Data Sources**.
8282

83-
2. In the **Data Sources** window, select**Add New Data Source** to start the **Data Source Configuration Wizard**.
83+
2. In the **Data Sources** window, select **Add New Data Source** to start the **Data Source Configuration Wizard**.
8484

8585
3. On the **Choose a Data Source Type** screen, select **Database**, and then select **Next**.
8686

@@ -96,7 +96,7 @@ This walkthrough uses SQL Server Express LocalDB and the Northwind sample databa
9696

9797
6. On the **Save connection string to the Application Configuration file**, select **Next**.
9898

99-
7. On the **Choose your Database Objects**screen, expand the **Tables** node.
99+
7. On the **Choose your Database Objects** screen, expand the **Tables** node.
100100

101101
8. Select the **Customers** and **Orders** tables, and then select **Finish**.
102102

docs/debugger/debug-interface-access/idiaenumdebugstreams-next.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ HRESULT Next ( 
3030

3131
#### Parameters
3232
celt
33-
[in] **T**he number of debug streams in the enumerator to be retrieved.
33+
[in] The number of debug streams in the enumerator to be retrieved.
3434

3535
rgelt
3636
[out] Returns an array of [IDiaEnumDebugStreamData](../../debugger/debug-interface-access/idiaenumdebugstreamdata.md) objects that represents the debug streams being retrieved.

docs/debugger/diagnose-problems-after-deployment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To diagnose issues in your ASP.NET web app after deployment by using IntelliTrac
3838

3939
Visual Studio 2017 does not include the *BuildInfo.config* file, which was deprecated and then removed. To debug ASP.NET web apps after deployment, use one of the following methods:
4040

41-
* For deployment to Azure, use [Application Insights](https://docs.microsoft.com/en-us/azure/application-insights/).
41+
* For deployment to Azure, use [Application Insights](https://docs.microsoft.com/azure/application-insights/).
4242

4343
* If you need to use IntelliTrace, open the project in Visual Studio and load the symbol files from the matching build. You can load symbol files from the **Modules** window or by configuring symbols in **Tools** > **Options** > **Debugging** > **Symbols**.
4444

docs/debugger/how-to-apply-edits-in-break-mode-with-edit-and-continue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ For limitations on using Edit and Continue while debugging, see [Supported Code
4242

4343
-or-
4444

45-
- When an exception occurs, choose **Enable Editing** on the**Exception Assistant**.
45+
- When an exception occurs, choose **Enable Editing** on the **Exception Assistant**.
4646

4747
2. Make any desired and supported code changes.
4848

docs/debugger/how-to-debug-dotnet-framework-source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To debug .NET Framework source, you must have access to debugging symbols for th
2020

2121
### To enable .NET Framework source debugging
2222

23-
1. On the **Tools** menu, click **Option**s.
23+
1. On the **Tools** menu, click **Options**.
2424

2525
2. In the **Options** dialog box, click the **Debugging** category.
2626

docs/debugger/how-to-use-the-threads-window.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ To begin this tutorial, you need a multithreaded application project. Follow the
3131

3232
The **New Project** dialog box appears.
3333

34-
2. In the **Project Type**s box, click the language of your choice: **Visual Basic**, **Visual C#**, or **Visual C++**.
34+
2. In the **Project Types** box, click the language of your choice: **Visual Basic**, **Visual C#**, or **Visual C++**.
3535

3636
3. Under **Windows Desktop**, choose **Console App**.
3737

docs/debugger/mfc-debugging-techniques.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ pMyPerson->Dump( afxDump );
434434

435435
4. In the **Copy Settings from** list, choose **Release**.
436436

437-
5. Click **OK** to close the **New Project Configuration**dialog box.
437+
5. Click **OK** to close the **New Project Configuration** dialog box.
438438

439439
6. Close the **Configuration Manager** dialog box.
440440

docs/extensibility/binding-keyboard-shortcuts-to-menu-items.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To bind a keyboard shortcut to a custom menu command, just add an entry to the *
3939
4. Try different combinations of keys until you find one that is not mapped.
4040

4141
> [!NOTE]
42-
> Keyboard shortcuts that use **Alt** may open a menu and not directly execute a command. Therefore, the **Shorcut currently used by** box may be blank when you type a shortcut that includes **Alt**. You can verify that the shortcut does not open a menu by closing the **Options** dialog box and then pressing the keys.
42+
> Keyboard shortcuts that use **Alt** may open a menu and not directly execute a command. Therefore, the **Shortcut currently used by** box may be blank when you type a shortcut that includes **Alt**. You can verify that the shortcut does not open a menu by closing the **Options** dialog box and then pressing the keys.
4343
4444
The following procedure assumes that you have an existing VSPackage with a menu command. If you need help doing that, take a look at [Create an extension with a menu command](../extensibility/creating-an-extension-with-a-menu-command.md).
4545

@@ -72,7 +72,7 @@ To bind a keyboard shortcut to a custom menu command, just add an entry to the *
7272

7373
In most situations, **Shift** should not be used without a second modifier because pressing it already causes most alphanumeric keys to type an uppercase letter or a symbol.
7474

75-
Virtual-key codes let you access special keys that do not have a character associated with them, for example, function keys and the **Backspace** key. For more information, see [Virtual-key codes](https://docs.microsoft.com/en-us/windows/desktop/inputdev/virtual-key-codes).
75+
Virtual-key codes let you access special keys that do not have a character associated with them, for example, function keys and the **Backspace** key. For more information, see [Virtual-key codes](https://docs.microsoft.com/windows/desktop/inputdev/virtual-key-codes).
7676

7777
To make the command available in the Visual Studio editor, set the `editor` attribute to `guidVSStd97`.
7878

docs/extensibility/internals/creating-project-instances-by-using-project-factories.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ Project types in [!INCLUDE[vsprvs](../../code-quality/includes/vsprvs_md.md)] us
2222

2323
You can implement the <xref:Microsoft.VisualStudio.Shell.Interop.IVsProjectFactory> interface in a class in your project. Typically, it resides in its own module.
2424

25-
For an example of an implementation of the `IVsProjectFactory` interface, see *PrjFac.cpp*, which is contained in the [Basic project](https://www.microsoft.com/download/details.aspx?id=55984) sample directory.
26-
2725
Projects that support being aggregated by an owner must persist an owner key in their project file. When the <xref:Microsoft.VisualStudio.Shell.Interop.IVsProjectFactory.CreateProject%2A> method is called on a project with an owner key, the owned project converts its owner key to a project factory GUID then calls the `CreateProject` method on this project factory to do the actual creation.
2826

2927
## Create an owned project

docs/extensibility/internals/guids-and-ids-of-visual-studio-commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The GUID and ID values of the commands included in the Visual Studio integrated
5151

5252
- Menu items that include an underlined character, such as the **Print** command on the **File** menu, in which the *P* is underlined.
5353

54-
Characters that are preceded by the ampersand (&) character in menu item names are displayed as underlined. However, *.vsct* files are written in XML, which uses the ampersand (&) character to indicate special characters and requires that an ampersand to be displayed must be spelled out as *&amp;amp;*. Therefore, in a *.vsct* file, the **P**rint command appears as *&amp;amp;Print*.
54+
Characters that are preceded by the ampersand (&) character in menu item names are displayed as underlined. However, *.vsct* files are written in XML, which uses the ampersand (&) character to indicate special characters and requires that an ampersand to be displayed must be spelled out as *&amp;amp;*. Therefore, in a *.vsct* file, the **Print** command appears as *&amp;amp;Print*.
5555

5656
- Commands that have dynamic text, such as **Save** \<Current Filename\>, and dynamically generated menu items, such as the items on the **Recent Files** list.
5757

docs/extensibility/internals/wizard-interface-idtwizard.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ STDMETHOD(Execute)(THIS_
3131
);
3232
```
3333

34-
The start mechanism is similar for both the **New Project** and **Add New Item**wizards. To start either, you call the <xref:EnvDTE.IDTWizard> interface defined in Dteinternal.h. The only difference is the set of context and custom parameters that are passed to the interface when the interface is called.
34+
The start mechanism is similar for both the **New Project** and **Add New Item** wizards. To start either, you call the <xref:EnvDTE.IDTWizard> interface defined in Dteinternal.h. The only difference is the set of context and custom parameters that are passed to the interface when the interface is called.
3535

3636
The following information describes the <xref:EnvDTE.IDTWizard> interface that wizards must implement to work in the [!INCLUDE[vsprvs](../../code-quality/includes/vsprvs_md.md)] IDE. The IDE calls the <xref:EnvDTE.IDTWizard.Execute%2A> method on the wizard, passing it the following:
3737

docs/ide/dotfuscator/capabilities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Many of these same methods may also be used to enforce [end-of-life deadlines][s
6060

6161
<!-- Copyright © 2017 PreEmptive Solutions, LLC -->
6262

63-
[assemblies]: https://docs.microsoft.com/en-us/dotnet/standard/assembly-format
63+
[assemblies]: https://docs.microsoft.com/dotnet/standard/assembly-format
6464
[uwp]: https://www.preemptive.com/blog/article/856-uwp-applications-in-dotfuscator-ce/91-dotfuscator-ce
6565
[xamarin]: https://www.preemptive.com/obfuscating-xamarin-with-dotfuscator
6666

docs/ide/dotfuscator/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ See [the full Dotfuscator CE User Guide at preemptive.com][full] for detailed us
7979

8080
<!-- Copyright © 2017 PreEmptive Solutions, LLC -->
8181

82-
[assemblies]: https://docs.microsoft.com/en-us/dotnet/standard/assembly-format
82+
[assemblies]: https://docs.microsoft.com/dotnet/standard/assembly-format
8383
[software-protection]: https://www.preemptive.com/software-protection
8484
[obfuscation]: https://www.preemptive.com/obfuscation
8585
[app-protection]: https://www.preemptive.com/application-protection

docs/ide/find-code-changes-and-other-history-with-codelens.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ You can find out how many people changed your code and how many changes were mad
121121

122122
### Find when your code was branched
123123

124-
To find when your code was branched, navigate to your code in the child branch. Then, select the **changes** indicator or press**Alt**+**6**:
124+
To find when your code was branched, navigate to your code in the child branch. Then, select the **changes** indicator or press **Alt**+**6**:
125125

126126
![CodeLens: Find when your code was branched](../ide/media/codelens-first-branch.png)
127127

@@ -291,7 +291,7 @@ To use the keyboard:
291291

292292
4. Press **Tab** to go to the **Show settings for** list, and then press **Down Arrow** to select **CodeLens**.
293293

294-
### Q: Can I move the CodeLens `head`s-up display?
294+
### Q: Can I move the CodeLens heads-up display?
295295

296296
**A:** Yes, choose ![Dock icon](../ide/media/codelensdockwindow.png) to dock CodeLens as a window.
297297

docs/ide/how-to-track-your-code-by-customizing-the-scrollbar.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ ms.date: 09/25/2018
44
ms.prod: visual-studio-dev15
55
ms.technology: vs-ide-general
66
ms.topic: conceptual
7-
f1_keywords:
8-
- "VS.ToolsOptionsPages.Text_Editor.All_Languages.Scroll_Bars"
97
author: gewarren
108
ms.author: gewarren
119
manager: douge

docs/ide/quickstart-python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Quickstart: use Visual Studio to create a Python web app"
33
description: In this quickstart, you use Visual Studio and the Flask framework to build a simple web app in Python.
4-
ms.date: 06/27/2018
4+
ms.date: 10/29/2018
55
ms.prod: visual-studio-dev15
66
ms.prod: visual-studio-dev15
77
ms.technology: vs-python

docs/ide/reference/build-events-dialog-box-visual-basic.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,26 @@ ms.workload:
2020
- "multiple"
2121
---
2222
# Build Events Dialog Box (Visual Basic)
23+
2324
Use the **Build Events** dialog box to specify build configuration instructions. You can also specify the conditions under which any pre-build or post-build events are run. For more information, see [How to: Specify Build Events (Visual Basic)](../../ide/how-to-specify-build-events-visual-basic.md).
2425

25-
**Pre-build event command line**
26-
Specifies any commands to execute before the build starts. To type long commands, click **Edit Pre-build** to display the [Pre-build Event/Post-build Event Command Line Dialog Box](../../ide/reference/pre-build-event-post-build-event-command-line-dialog-box.md).
26+
**Pre-build event command line**
27+
28+
Specifies any commands to execute before the build starts. To type long commands, click **Edit Pre-build** to display the [Pre-build Event/Post-build Event Command Line Dialog Box](../../ide/reference/pre-build-event-post-build-event-command-line-dialog-box.md).
2729

2830
> [!NOTE]
2931
> Pre-build events do not run if the project is up-to-date and no build is triggered.
3032
33+
**Post-build event command line**
3134

32-
**Post-build event command line**
33-
Specifies any commands to execute after the build ends. To type long commands, click **Edit Post-build** to display the **Pre-build Event/Post-build Event Command Line d**ialog box.
35+
Specifies any commands to execute after the build ends. To type long commands, click **Edit Post-build** to display the **Pre-build Event/Post-build Event Command Line** dialog box.
3436

3537
> [!NOTE]
3638
> Add a `call` statement before all post-build commands that run .bat files. For example, `call C:\MyFile.bat` or `call C:\MyFile.bat call C:\MyFile2.bat`.
3739
40+
**Run the post-build event**
3841

39-
**Run the post-build event**
40-
Specifies the conditions for the post-build event to run, as shown in the following table.
42+
Specifies the conditions for the post-build event to run, as shown in the following table.
4143

4244
|Option|Result|
4345
|------------|------------|

docs/ide/reference/fonts-and-colors-environment-options-dialog-box.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Lists the items for which you can modify the foreground and background color.
141141
|**Keyword**|Keywords for the given language that are reserved. For example: class and namespace.|
142142
|**Memory Address**|The color of text used to display the address column inside the **Memory** window.|
143143
|**Memory Changed**|The color of text used to display changed data inside the **Memory** window.|
144-
|**Memory Data**|The color of text used to display data inside the M**emory** window.|
144+
|**Memory Data**|The color of text used to display data inside the **Memory** window.|
145145
|**Memory Unreadable**|The color of text used to display unreadable memory areas within the **Memory** window.|
146146
|**Number**|A number in code that represents an actual numeric value.|
147147
|**Operator**|Operators such as +, -, and !=.|

0 commit comments

Comments
 (0)