Skip to content

Commit 1fd1202

Browse files
TaojunshenTylerMSFTTylerMSFTColin Robertsonystamant
authored
8/6/2021 AM Publish (#3707)
* fix code sample (#3676) * fix code sample * acrolinx Co-authored-by: TylerMSFT <Tyler.Whitney@microsoft.com> * Address 3269 typo in warning number (#3680) * Fixed typo: evalution --> evaluation * Bulk Fix - Sentence form for all alt text (#3683) * Updated C/C++ workload name The workload for C/C++ development in VS Build Tools 2019 installer is called 'Desktop development with C++'. * Split out docs by version Add VS2017-specific instructions. * Add 16.11 Compiler Warnings C5247 and C5248 (MicrosoftDocs#3689) * Add C5247 and C5248 * Fix link typos * Updates per Xiang Fan review * More wordsmithage * More fix per X.F. * Fix inconsistencies in CMake docs (MicrosoftDocs#3692) * Standard format for CMake docs * Fix markdownlint * More cleanup. * Clean up link issue, acrolinx * Fix more broken things * Undo a change * Update markdownlint.json file for unordered lists (#3694) Block rule that wants * instead of - to prefix unordered lists, since we've standardized on the latter. Merging on my own recognizance as repo admin. * Markdown quality fixes 1 of N * Markdown quality fixes 2 of N * Markdown quality fixes 3 of N * Markdown quality fixes 4 of N * Markdown quality fixes 5 of N * Markdown quality fixes 6 of N * Markdown quality fixes 7 of N * Markdown quality fixes 8 of N * Markdown quality fixes 9 of N * Markdown quality fixes 10 of N * Undo TN038 * Markdown quality fixes 11 of N Co-authored-by: Tyler Whitney <TylerMSFT@users.noreply.github.com> Co-authored-by: TylerMSFT <Tyler.Whitney@microsoft.com> Co-authored-by: Colin Robertson <corob@microsoft.com> Co-authored-by: ystamant <49958001+ystamant@users.noreply.github.com> Co-authored-by: Andrew Shymanel <88244804+ainrd@users.noreply.github.com> Co-authored-by: PRMerger6 <prmrgr6@microsoft.com> Co-authored-by: PRMerger12 <prmrgr12@microsoft.com> Co-authored-by: PRMerger14 <prmrgr14@microsoft.com> Co-authored-by: PRMerger16 <prmrgr16@microsoft.com> Co-authored-by: PRMerger15 <prmrgr15@microsoft.com> Co-authored-by: PRMerger7 <prmrgr7@microsoft.com> Co-authored-by: PRMerger10 <prmrgr10@microsoft.com>
1 parent 147da8d commit 1fd1202

97 files changed

Lines changed: 264 additions & 409 deletions

File tree

Some content is hidden

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

‎docs/atl-mfc-shared/reference/coledatetime-class.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,12 +128,10 @@ The `COleDateTime` object to be compared.
128128
> [!NOTE]
129129
> An ATLASSERT will occur if either of the two operands is invalid.
130130
131-
### Example
131+
### Examples
132132

133133
[!code-cpp[NVC_ATLMFC_Utilities#13](../../atl-mfc-shared/codesnippet/cpp/coledatetime-class_2.cpp)]
134134

135-
### Example
136-
137135
The operators **>=**, **\<=**, **>**, and **<**, will assert if the `COleDateTime` object is set to null.
138136

139137
[!code-cpp[NVC_ATLMFC_Utilities#170](../../atl-mfc-shared/codesnippet/cpp/coledatetime-class_3.cpp)]

‎docs/atl-mfc-shared/reference/crect-class.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ BOOL EqualRect(LPCRECT lpRect) const throw();
396396
### Parameters
397397
398398
*`lpRect`*<br/>
399-
Points to a [`RECT](/windows/win32/api/windef/ns-windef-rect) structure or `CRect` object that contains the upper-left and lower-right corner coordinates of a rectangle.
399+
Points to a [`RECT`](/windows/win32/api/windef/ns-windef-rect) structure or `CRect` object that contains the upper-left and lower-right corner coordinates of a rectangle.
400400
401401
### Return Value
402402

‎docs/atl-mfc-shared/reference/csimplestringt-class.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -337,8 +337,6 @@ _tprintf_s(_T("Alloc length is %d, String length is %d\n"),
337337
str.GetAllocLength(), str.GetLength());
338338
```
339339
340-
### Remarks
341-
342340
The output from this example is as follows:
343341
344342
```Output

‎docs/atl/programming-with-ccombstr-atl.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,7 @@ Although several `CComBSTR` methods will automatically convert an ANSI string ar
2727

2828
[!code-cpp[NVC_ATL_Utilities#114](../atl/codesnippet/cpp/programming-with-ccombstr-atl_1.cpp)]
2929

30-
If you are using a string literal to modify a `CComBSTR` object, use wide character strings. This will reduce unnecessary conversions.
31-
32-
### Example
30+
If you're using a string literal to modify a `CComBSTR` object, use wide character strings to reduce unnecessary conversions.
3331

3432
[!code-cpp[NVC_ATL_Utilities#115](../atl/codesnippet/cpp/programming-with-ccombstr-atl_2.cpp)]
3533

‎docs/atl/reference/cwindow-class.md‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -874,9 +874,7 @@ BOOL GetDlgItemText(
874874
875875
### Remarks
876876
877-
See [GetDlgItemText](/windows/win32/api/winuser/nf-winuser-getdlgitemtextw) in the Windows SDK.
878-
879-
### Remarks
877+
For more information, see [`GetDlgItemText`](/windows/win32/api/winuser/nf-winuser-getdlgitemtextw) in the Windows SDK.
880878
881879
The second version of this method allows you to copy the control's text to a BSTR. This version returns TRUE if the text is successfully copied; otherwise, FALSE.
882880
@@ -1209,9 +1207,7 @@ LONG_PTR GetWindowLongPtr(int nIndex) const throw();
12091207
12101208
### Remarks
12111209
1212-
See [GetWindowLongPtr](/windows/win32/api/winuser/nf-winuser-getwindowlongptrw) in the Windows SDK.
1213-
1214-
### Remarks
1210+
For more information, see [`GetWindowLongPtr`](/windows/win32/api/winuser/nf-winuser-getwindowlongptrw) in the Windows SDK.
12151211
12161212
If you are retrieving a pointer or a handle, this function supersedes the `CWindow::GetWindowLong` method.
12171213
@@ -1429,9 +1425,7 @@ void InvalidateRgn(HRGN hRgn, BOOL bErase = TRUE) throw();
14291425
14301426
### Remarks
14311427
1432-
See [InvalidateRgn](/windows/win32/api/winuser/nf-winuser-invalidatergn) in the Windows SDK.
1433-
1434-
### Remarks
1428+
For more information, see [`InvalidateRgn`](/windows/win32/api/winuser/nf-winuser-invalidatergn) in the Windows SDK.
14351429
14361430
Specifies a **`void`** return type, while the `InvalidateRgn` Win32 function always returns TRUE.
14371431

‎docs/build/reference/headername.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,20 +36,20 @@ If you specify **`/headerName:{quote,angle}`**, you must also specify [`/exportH
3636
Given a project that references a header file it defines called `m.h`, the compiler option to compile it into a header unit looks similar to this:
3737

3838
```Bash
39-
$ cl /std:c++latest /exportHeader /headerName:quote m.h /Fom.h.obj
39+
cl /std:c++latest /exportHeader /headerName:quote m.h /Fom.h.obj
4040
```
4141

4242
The `/headerName:{quote,angle}`switch acts like a flag and does not explicitly need an argument. The following examples are valid:
4343

4444
```Bash
45-
$ cl /std:c++latest /exportHeader /headerName:angle /MP /Fo.\ vector iostream algorithm
46-
$ cl /std:c++latest /exportHeader /headerName:quote /MP /Fo.\ my-utilities.h a/b/my-core.h
45+
cl /std:c++latest /exportHeader /headerName:angle /MP /Fo.\ vector iostream algorithm
46+
cl /std:c++latest /exportHeader /headerName:quote /MP /Fo.\ my-utilities.h a/b/my-core.h
4747
```
4848

4949
You can specify multiple `/headerName` switches on the same command line, and every argument after that switch will be processed with the specified *`header-filename`* lookup rules. The following example processes all the headers as the previous two command line examples in the same way. It looks up the headers using the lookup rules applied as if they had been specified as: `#include <vector>`, `#include "my-utilties.h"`, and `#include "a/b/my-core.h"`:
5050

5151
```bash
52-
$ cl /std:c++latest /exportHeader /headerName:angle /MP /Fo.\ vector iostream algorithm /headerName:quote my-utilities.h a/b/my-core.h
52+
cl /std:c++latest /exportHeader /headerName:angle /MP /Fo.\ vector iostream algorithm /headerName:quote my-utilities.h a/b/my-core.h
5353
```
5454

5555
### To set this compiler option in the Visual Studio development environment

‎docs/build/reference/module-exportheader.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The argument to `/exportHeader` is a `/headerName` command-line option that spec
2525

2626
**`/exportHeader`** is available starting in Visual Studio 2019 version 16.10 Preview 2.
2727

28-
The **`/exportHeader`** compiler option requires you enable the [/std:c++latest](std-specify-language-standard-version.md) option.
28+
The **`/exportHeader`** compiler option requires you enable the [`/std:c++latest`](std-specify-language-standard-version.md) option.
2929

3030
One **`/exportHeader`** compiler option can specify as many header-name arguments as your build requires. You don't need to specify them separately.
3131

‎docs/build/reference/sourcedependencies-directives.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,4 +101,4 @@ You normally shouldn't set this yourself in the Visual Studio development enviro
101101
## See also
102102

103103
[MSVC compiler options](compiler-options.md)\
104-
[MSVC compiler command-line syntax](compiler-command-line-syntax.md)
104+
[MSVC compiler command-line syntax](compiler-command-line-syntax.md)

‎docs/build/reference/translateinclude.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,6 @@ To enable `/translateInclude`, set the **Translate Includes to Imports** option
6969
1. Change the **Translate Includes to Imports** dropdown to **Yes**
7070
![Screenshot of the Property Pages dialog with the Translate Includes to Imports property highlighted.](../media/vs2019-translate-includes-option.png)
7171

72-
7372
## See also
7473

7574
[`/headerUnit` (Use header unit IFC)](headerunit.md).\

‎docs/build/reference/vmm-vms-vmv-general-purpose-representation.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ When you specify one of these inheritance-model options, that model gets used fo
5454

5555
1. Enter the compiler option in the **Additional Options** box.
5656

57-
5857
### To set this compiler option programmatically
5958

6059
- See <xref:Microsoft.VisualStudio.VCProjectEngine.VCCLCompilerTool.AdditionalOptions%2A>.

0 commit comments

Comments
 (0)