Skip to content

Commit 6e9ed27

Browse files
authored
Merge pull request #3154 from MicrosoftDocs/master636918999083723222
For protected CLA branch, push strategy should use PR and merge to target branch method to work around git push error
2 parents f0c49ec + 3fe6bed commit 6e9ed27

File tree

537 files changed

+3092
-1737
lines changed

Some content is hidden

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

537 files changed

+3092
-1737
lines changed

.openpublishing.redirection.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1280,6 +1280,11 @@
12801280
"redirect_url": "/visualstudio/ide/class-designer/designing-and-viewing-classes-and-types",
12811281
"redirect_document_id": false
12821282
},
1283+
{
1284+
"source_path": "docs/ide/code-styles-and-quick-actions.md",
1285+
"redirect_url": "/visualstudio/ide/code-styles-and-code-cleanup",
1286+
"redirect_document_id": false
1287+
},
12831288
{
12841289
"source_path": "docs/ide/command-line-arguments-for-the-help-content-manager.md",
12851290
"redirect_url": "/visualstudio/help-viewer/command-line-arguments",

docs/code-quality/analyzers-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This page contains answers to some frequently asked questions about Roslyn analy
1818

1919
**Q**: Should I use Roslyn analyzers or .editorconfig for code style?
2020

21-
**A**: Roslyn analyzers and .editorconfig files work hand-in-hand. When you define code styles [in an .editorconfig file](../ide/editorconfig-code-style-settings-reference.md) or on the [text editor Options](../ide/code-styles-and-quick-actions.md) page, you're actually configuring the Roslyn analyzers that are built into Visual Studio. EditorConfig files can also be used to configure some third-party analyzer packages, such as [FxCop analyzers](configure-fxcop-analyzers.md).
21+
**A**: Roslyn analyzers and .editorconfig files work hand-in-hand. When you define code styles [in an .editorconfig file](../ide/editorconfig-code-style-settings-reference.md) or on the [text editor Options](../ide/code-styles-and-code-cleanup.md) page, you're actually configuring the Roslyn analyzers that are built into Visual Studio. EditorConfig files can also be used to configure some third-party analyzer packages, such as [FxCop analyzers](configure-fxcop-analyzers.md).
2222

2323
## EditorConfig versus rule sets
2424

docs/code-quality/roslyn-analyzers-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.workload:
1414
---
1515
# Overview of .NET Compiler Platform analyzers
1616

17-
.NET Compiler Platform ("Roslyn") analyzers analyze your code for style, quality and maintainability, design, and other issues. Visual Studio includes a built-in set of analyzers that analyze your C# or Visual Basic code as you type. You configure preferences for these built-in analyzers on the [text editor Options](../ide/code-styles-and-quick-actions.md) page or in an [.editorconfig file](../ide/editorconfig-code-style-settings-reference.md). You can install additional analyzers as a Visual Studio extension or a NuGet package.
17+
.NET Compiler Platform ("Roslyn") analyzers analyze your code for style, quality and maintainability, design, and other issues. Visual Studio includes a built-in set of analyzers that analyze your C# or Visual Basic code as you type. You configure preferences for these built-in analyzers on the [text editor Options](../ide/code-styles-and-code-cleanup.md) page or in an [.editorconfig file](../ide/editorconfig-code-style-settings-reference.md). You can install additional analyzers as a Visual Studio extension or a NuGet package.
1818

1919
If rule violations are found by an analyzer, they are reported in the code editor (as a *squiggly* under the offending code) and in the **Error List** window.
2020

docs/extensibility/debugger/reference/idebugalias-geticordebugvalue.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ ms.author: "gregvanl"
1212
manager: jillfra
1313
ms.workload:
1414
- "vssdk"
15+
dev_langs:
16+
- CPP
17+
- CSharp
1518
---
1619
# IDebugAlias::GetICorDebugValue
1720
Retrieves a managed code interface that represents the value associated with this alias.
@@ -30,8 +33,8 @@ int GetICorDebugValue(
3033
);
3134
```
3235

33-
#### Parameters
34-
`ppUnk`
36+
## Parameters
37+
`ppUnk`\
3538

3639
[out] `IUnknown` interface that represents the value associated with this alias. This interface can be queried for the `ICorDebugValue` interface.
3740

@@ -41,5 +44,5 @@ int GetICorDebugValue(
4144
## Remarks
4245
This method applies only to managed values (the `ICorDebugValue` is an interface available in the [!INCLUDE[dnprdnshort](../../../code-quality/includes/dnprdnshort_md.md)] and is defined in the [!INCLUDE[dnprdnshort](../../../code-quality/includes/dnprdnshort_md.md)] SDK in the cordebug.idl file).
4346

44-
## See Also
47+
## See also
4548
- [IDebugAlias](../../../extensibility/debugger/reference/idebugalias.md)

docs/extensibility/debugger/reference/idebugalias-getname.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ ms.author: "gregvanl"
1212
manager: jillfra
1313
ms.workload:
1414
- "vssdk"
15+
dev_langs:
16+
- CPP
17+
- CSharp
1518
---
1619
# IDebugAlias::GetName
1720
Gets the name of this alias.
@@ -30,13 +33,13 @@ int GetName(
3033
);
3134
```
3235

33-
#### Parameters
34-
`pbstrName`
36+
## Parameters
37+
`pbstrName`\
3538

3639
[out] Name of the alias.
3740

3841
## Return Value
3942
If successful, returns S_OK; otherwise, returns an error code.
4043

41-
## See Also
44+
## See also
4245
- [IDebugAlias](../../../extensibility/debugger/reference/idebugalias.md)

docs/extensibility/debugger/reference/idebugalias-getobject.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ ms.author: "gregvanl"
1212
manager: jillfra
1313
ms.workload:
1414
- "vssdk"
15+
dev_langs:
16+
- CPP
17+
- CSharp
1518
---
1619
# IDebugAlias::GetObject
1720
Gets the object that this alias is for.
@@ -30,14 +33,14 @@ int GetObject(
3033
)
3134
```
3235

33-
#### Parameters
34-
`ppObject`
36+
## Parameters
37+
`ppObject`\
3538

3639
[out] The [IDebugObject2](../../../extensibility/debugger/reference/idebugobject2.md) this alias represents.
3740

3841
## Return Value
3942
If successful, returns S_OK; otherwise, returns an error code.
4043

41-
## See Also
44+
## See also
4245
- [IDebugAlias](../../../extensibility/debugger/reference/idebugalias.md)
4346
- [IDebugObject2](../../../extensibility/debugger/reference/idebugobject2.md)

docs/extensibility/debugger/reference/idebugarrayfield-getelementtype.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ ms.author: "gregvanl"
1212
manager: jillfra
1313
ms.workload:
1414
- "vssdk"
15+
dev_langs:
16+
- CPP
17+
- CSharp
1518
---
1619
# IDebugArrayField::GetElementType
1720
Gets the type of element in the array.
@@ -30,8 +33,8 @@ int GetElementType(
3033
);
3134
```
3235

33-
#### Parameters
34-
`ppType`
36+
## Parameters
37+
`ppType`\
3538

3639
[out] Returns an [IDebugField](../../../extensibility/debugger/reference/idebugfield.md) object that describes the type of element.
3740

@@ -41,6 +44,6 @@ int GetElementType(
4144
## Remarks
4245
The [IDebugArrayField](../../../extensibility/debugger/reference/idebugarrayfield.md) object assumes that all elements of the array are the same type.
4346

44-
## See Also
47+
## See also
4548
- [IDebugArrayField](../../../extensibility/debugger/reference/idebugarrayfield.md)
4649
- [IDebugField](../../../extensibility/debugger/reference/idebugfield.md)

docs/extensibility/debugger/reference/idebugarrayfield-getnumberofelements.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ ms.author: "gregvanl"
1212
manager: jillfra
1313
ms.workload:
1414
- "vssdk"
15+
dev_langs:
16+
- CPP
17+
- CSharp
1518
---
1619
# IDebugArrayField::GetNumberOfElements
1720
Gets the number of elements in the array.
@@ -30,8 +33,8 @@ int GetNumberOfElements(
3033
);
3134
```
3235

33-
#### Parameters
34-
`pdwNumElements`
36+
## Parameters
37+
`pdwNumElements`\
3538

3639
[out] Returns the number of elements in the array.
3740

@@ -41,5 +44,5 @@ int GetNumberOfElements(
4144
## Remarks
4245
The value returned is the total number of elements in the array, regardless of the number of dimensions.
4346

44-
## See Also
47+
## See also
4548
- [IDebugArrayField](../../../extensibility/debugger/reference/idebugarrayfield.md)

docs/extensibility/debugger/reference/idebugarrayfield-getrank.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ ms.author: "gregvanl"
1212
manager: jillfra
1313
ms.workload:
1414
- "vssdk"
15+
dev_langs:
16+
- CPP
17+
- CSharp
1518
---
1619
# IDebugArrayField::GetRank
1720
Gets the rank or number of dimensions of the array.
@@ -30,8 +33,8 @@ int GetRank(
3033
);
3134
```
3235

33-
#### Parameters
34-
`pdwRank`
36+
## Parameters
37+
`pdwRank`\
3538

3639
[out] Returns the rank.
3740

@@ -41,5 +44,5 @@ int GetRank(
4144
## Remarks
4245
The rank of an array corresponds to the number of dimensions. In C++ and C#, multi-dimensional arrays are really arrays of arrays and can therefore be considered just a one-dimensional array (and the `GetRank` method always returns 1). In [!INCLUDE[vbprvb](../../../code-quality/includes/vbprvb_md.md)], on the other hand, multi-dimensional arrays are handled differently and the rank of such an array reflects the number of dimensions (and the `GetRank` method always returns the number of dimensions).
4346

44-
## See Also
47+
## See also
4548
- [IDebugArrayField](../../../extensibility/debugger/reference/idebugarrayfield.md)

docs/extensibility/debugger/reference/idebugarrayfield.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ IDebugArrayField : IDebugContainerField
4444

4545
Assembly: Microsoft.VisualStudio.Debugger.Interop.dll
4646

47-
## See Also
47+
## See also
4848
- [Symbol Provider Interfaces](../../../extensibility/debugger/reference/symbol-provider-interfaces.md)
4949
- [IDebugContainerField](../../../extensibility/debugger/reference/idebugcontainerfield.md)
5050
- [IDebugField](../../../extensibility/debugger/reference/idebugfield.md)

docs/extensibility/debugger/reference/idebugarrayobject-getcount.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ ms.author: "gregvanl"
1212
manager: jillfra
1313
ms.workload:
1414
- "vssdk"
15+
dev_langs:
16+
- CPP
17+
- CSharp
1518
---
1619
# IDebugArrayObject::GetCount
1720
Gets the count of elements in the array.
@@ -30,8 +33,8 @@ int GetCount(
3033
);
3134
```
3235

33-
#### Parameters
34-
`pdwElements`
36+
## Parameters
37+
`pdwElements`\
3538

3639
[out] Returns the count.
3740

@@ -41,5 +44,5 @@ int GetCount(
4144
## Remarks
4245
This method sees all of the elements of an array object as a one-dimensional array, even if the array object is multi-dimensional. For example, given the array `myarray[3][2][6]`, this method would return 36 in the `pdwElements` parameter. Use the [GetElement](../../../extensibility/debugger/reference/idebugarrayobject-getelement.md) method to retrieve the individual elements one at a time.
4346

44-
## See Also
47+
## See also
4548
- [IDebugArrayObject](../../../extensibility/debugger/reference/idebugarrayobject.md)

docs/extensibility/debugger/reference/idebugarrayobject-getdimensions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ int GetDimensions(
3232
);
3333
```
3434

35-
#### Parameters
36-
`dwCount`
35+
## Parameters
36+
`dwCount`\
3737

3838
[in] The number of dimensions to retrieve.
3939

40-
`dwDimensions`
40+
`dwDimensions`\
4141

4242
[in, out] An array that is filled in with the sizes of each dimension. `dwCount` specifies the maximum size of the `dwDimensions` array.
4343

@@ -47,5 +47,5 @@ int GetDimensions(
4747
## Remarks
4848
A multi-dimensional array can have different sizes for each dimension. For example, given the three-dimensional array `myarray[3][2][6]`, this method would return 3, 2, and 6 in the `dwDimensions` parameter in that order.
4949

50-
## See Also
50+
## See also
5151
- [IDebugArrayObject](../../../extensibility/debugger/reference/idebugarrayobject.md)

docs/extensibility/debugger/reference/idebugarrayobject-getelement.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ ms.author: "gregvanl"
1212
manager: jillfra
1313
ms.workload:
1414
- "vssdk"
15+
dev_langs:
16+
- CPP
17+
- CSharp
1518
---
1619
# IDebugArrayObject::GetElement
1720
Gets an element of the array.
@@ -33,11 +36,11 @@ int GetElement(
3336
```
3437

3538
#### Parameters
36-
`dwIndex`
39+
`dwIndex`\
3740

3841
[in] The element index.
3942

40-
`ppElement`
43+
`ppElement`\
4144

4245
[out] Returns an [IDebugObject](../../../extensibility/debugger/reference/idebugobject.md) interface that represents the element.
4346

@@ -47,5 +50,5 @@ int GetElement(
4750
## Remarks
4851
This method sees all of the elements of an array object as a one-dimensional array, even if the array object is multi-dimensional. For example, given the array `myarray[3][2][6]` and a `dwIndex` parameter of 20, this method would return the element from `myarray[1][1][2]`, and a `dwIndex` parameter of 21 would return the element from `myarray[1][1][3]`. Use the [GetCount](../../../extensibility/debugger/reference/idebugarrayobject-getcount.md) method to determine the total number of elements in the array.
4952

50-
## See Also
53+
## See also
5154
- [IDebugArrayObject](../../../extensibility/debugger/reference/idebugarrayobject.md)

docs/extensibility/debugger/reference/idebugarrayobject-getelements.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ ms.author: "gregvanl"
1212
manager: jillfra
1313
ms.workload:
1414
- "vssdk"
15+
dev_langs:
16+
- CPP
17+
- CSharp
1518
---
1619
# IDebugArrayObject::GetElements
1720
Gets an enumerator of all elements of the array.
@@ -30,8 +33,8 @@ int GetElements(
3033
);
3134
```
3235

33-
#### Parameters
34-
`ppEnum`
36+
## Parameters
37+
`ppEnum`\
3538

3639
[out] Returns an [IEnumDebugObjects](../../../extensibility/debugger/reference/ienumdebugobjects.md) object that allows enumerating over all elements.
3740

@@ -41,5 +44,5 @@ int GetElements(
4144
## Remarks
4245
As an alternative, use the [GetCount](../../../extensibility/debugger/reference/idebugarrayobject-getcount.md) and [GetElement](../../../extensibility/debugger/reference/idebugarrayobject-getelement.md) methods to iterate through the elements.
4346

44-
## See Also
47+
## See also
4548
- [IDebugArrayObject](../../../extensibility/debugger/reference/idebugarrayobject.md)

docs/extensibility/debugger/reference/idebugarrayobject-getrank.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ ms.author: "gregvanl"
1212
manager: jillfra
1313
ms.workload:
1414
- "vssdk"
15+
dev_langs:
16+
- CPP
17+
- CSharp
1518
---
1619
# IDebugArrayObject::GetRank
1720
Gets the rank of the array, that is, the number of dimensions.
@@ -30,8 +33,8 @@ int GetRank(
3033
);
3134
```
3235

33-
#### Parameters
34-
`pdwRank`
36+
## Parameters
37+
`pdwRank`\
3538

3639
[out] Returns the rank.
3740

@@ -41,5 +44,5 @@ int GetRank(
4144
## Remarks
4245
Use the [GetDimensions](../../../extensibility/debugger/reference/idebugarrayobject-getdimensions.md) method to retrieve the size of each dimension of the array object.
4346

44-
## See Also
47+
## See also
4548
- [IDebugArrayObject](../../../extensibility/debugger/reference/idebugarrayobject.md)

docs/extensibility/debugger/reference/idebugarrayobject.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,5 @@ IDebugArrayObject : IDebugObject
5252

5353
Assembly: Microsoft.VisualStudio.Debugger.Interop.dll
5454

55-
## See Also
55+
## See also
5656
- [IDebugObject](../../../extensibility/debugger/reference/idebugobject.md)

docs/extensibility/debugger/reference/idebugarrayobject2-getbaseindices.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ ms.author: "gregvanl"
1111
manager: jillfra
1212
ms.workload:
1313
- "vssdk"
14+
dev_langs:
15+
- CPP
16+
- CSharp
1417
---
1518
# IDebugArrayObject2::GetBaseIndices
1619
Retrieves the base indices (lower bounds) for each index given the number of dimensions in the array.
@@ -32,11 +35,11 @@ int GetBaseIndices (
3235
```
3336

3437
#### Parameters
35-
`dwRank`
38+
`dwRank`\
3639

3740
[in] The number of dimensions (rank) of the array.
3841

39-
`dwIndices`
42+
`dwIndices`\
4043

4144
[out] The base indices (lower bounds) for the array.
4245

@@ -52,5 +55,5 @@ int[] lowerbounds = { 5 };
5255
Array.CreateInstance(typeof(int), lengths, lowerbounds);
5356
```
5457

55-
## See Also
58+
## See also
5659
- [IDebugArrayObject2](../../../extensibility/debugger/reference/idebugarrayobject2.md)

0 commit comments

Comments
 (0)