Skip to content

Commit 657b857

Browse files
authored
Merge pull request #2532 from LizCasey/v-elicas071718
Content fixes for VS extensibility-debugger articles, Task 1303377.
2 parents 58b8b7b + c5de50e commit 657b857

20 files changed

+102
-102
lines changed

docs/extensibility/debugger/asynctaskmethodbuilder-m-builder-field.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ manager: douge
1414
ms.workload:
1515
- "vssdk"
1616
---
17-
# AsyncTaskMethodBuilder.m_builder Field
17+
# AsyncTaskMethodBuilder.m_builder field
1818
Represents the generic builder object to which this non-generic instance delegates.
1919

2020
**Namespace:** <xref:System.Runtime.CompilerServices?displayProperty=fullName>
@@ -25,12 +25,12 @@ Represents the generic builder object to which this non-generic instance delegat
2525

2626
## Syntax
2727

28-
```
28+
```csharp
2929
.field private valuetype System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1<valuetype System.Threading.Tasks.VoidTaskResult> m_builder
3030
```
3131

3232
## Remarks
3333

34-
## See Also
34+
## See also
3535
<xref:System.Runtime.CompilerServices.AsyncTaskMethodBuilder>
36-
[Parallel Extension Internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)
36+
[Parallel extension internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)

docs/extensibility/debugger/asynctaskmethodbuilder-objectidfordebugger-property.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ manager: douge
1414
ms.workload:
1515
- "vssdk"
1616
---
17-
# AsyncTaskMethodBuilder.ObjectIdForDebugger Property
17+
# AsyncTaskMethodBuilder.ObjectIdForDebugger property
1818
Gets an object that may be used to uniquely identify this builder to the debugger.
1919

2020
**Namespace:** <xref:System.Runtime.CompilerServices?displayProperty=fullName>
@@ -29,6 +29,6 @@ Gets an object that may be used to uniquely identify this builder to the debugge
2929
private object ObjectIdForDebugger
3030
```
3131

32-
## See Also
32+
## See also
3333
<xref:System.Runtime.CompilerServices.AsyncTaskMethodBuilder%601>
34-
[Parallel Extension Internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)
34+
[Parallel extension internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)

docs/extensibility/debugger/asynctaskmethodbuilder-structure-internal-members.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ manager: douge
1515
ms.workload:
1616
- "vssdk"
1717
---
18-
# AsyncTaskMethodBuilder Structure - Internal Members
18+
# AsyncTaskMethodBuilder structure - internal members
1919
This topic describes the internal members of the <xref:System.Runtime.CompilerServices.AsyncTaskMethodBuilder> class. For general information about this class, see the <xref:System.Runtime.CompilerServices.AsyncTaskMethodBuilder> reference topic.
2020

2121
**Namespace:** <xref:System.Runtime.CompilerServices?displayProperty=fullName>
@@ -26,19 +26,19 @@ This topic describes the internal members of the <xref:System.Runtime.CompilerSe
2626

2727
## Syntax
2828

29-
```
29+
```csharp
3030
.class public sequential ansi sealed beforefieldinit System.Runtime.CompilerServices.AsyncTaskMethodBuilder
3131
extends System.ValueType
3232
implements System.Runtime.CompilerServices.IAsyncMethodBuilder
3333
```
3434

35-
## Internal Members
35+
## Internal members
3636

3737
|Name|Description|
3838
|----------|-----------------|
3939
|[ObjectIdForDebugger property](../../extensibility/debugger/asynctaskmethodbuilder-objectidfordebugger-property.md)|Gets an object that may be used to uniquely identify this builder to the debugger.|
4040
|[m_builder field](../../extensibility/debugger/asynctaskmethodbuilder-m-builder-field.md)|Represents the generic builder object to which this non-generic instance delegates.|
4141

42-
## See Also
42+
## See also
4343
<xref:System.Runtime.CompilerServices.AsyncTaskMethodBuilder>
44-
[Parallel Extension Internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)
44+
[Parallel extension internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)

docs/extensibility/debugger/asynctaskmethodbuilder-tresult-m-task-field.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ manager: douge
1414
ms.workload:
1515
- "vssdk"
1616
---
17-
# AsyncTaskMethodBuilder&lt;TResult&gt;.m_task Field
17+
# AsyncTaskMethodBuilder&lt;TResult&gt;.m_task field
1818
Represents the lazily initialized built task.
1919

2020
**Namespace:** <xref:System.Runtime.CompilerServices?displayProperty=fullName>
@@ -25,10 +25,10 @@ Represents the lazily initialized built task.
2525

2626
## Syntax
2727

28-
```
28+
```csharp
2929
.field private class System.Threading.Tasks.Task`1<!TResult> m_task
3030
```
3131

32-
## See Also
32+
## See also
3333
<xref:System.Runtime.CompilerServices.AsyncTaskMethodBuilder%601>
34-
[Parallel Extension Internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)
34+
[Parallel extension internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)

docs/extensibility/debugger/asynctaskmethodbuilder-tresult-objectidfordebugger-property.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ manager: douge
1414
ms.workload:
1515
- "vssdk"
1616
---
17-
# AsyncTaskMethodBuilder&lt;TResult&gt;.ObjectIdForDebugger Property
17+
# AsyncTaskMethodBuilder&lt;TResult&gt;.ObjectIdForDebugger property
1818
Gets an object that may be used to uniquely identify this builder to the debugger.
1919

2020
**Namespace:** <xref:System.Runtime.CompilerServices?displayProperty=fullName>
@@ -29,6 +29,6 @@ Gets an object that may be used to uniquely identify this builder to the debugge
2929
private object ObjectIdForDebugger
3030
```
3131

32-
## See Also
32+
## See also
3333
<xref:System.Runtime.CompilerServices.AsyncTaskMethodBuilder%601>
34-
[Parallel Extension Internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)
34+
[Parallel extension internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)

docs/extensibility/debugger/asynctaskmethodbuilder-tresult-structure-internal-members.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ manager: douge
1515
ms.workload:
1616
- "vssdk"
1717
---
18-
# AsyncTaskMethodBuilder&lt;TResult&gt; Structure - Internal Members
18+
# AsyncTaskMethodBuilder&lt;TResult&gt; structure - internal members
1919
This topic describes the internal members of the <xref:System.Runtime.CompilerServices.AsyncTaskMethodBuilder%601> class. For general information about this class, see the <xref:System.Runtime.CompilerServices.AsyncTaskMethodBuilder%601> reference topic.
2020

2121
**Namespace:** <xref:System.Runtime.CompilerServices?displayProperty=fullName>
@@ -26,19 +26,19 @@ This topic describes the internal members of the <xref:System.Runtime.CompilerSe
2626

2727
## Syntax
2828

29-
```
29+
```csharp
3030
.class public sequential ansi sealed beforefieldinit System.Runtime.CompilerServices.AsyncTaskMethodBuilder`1<TResult>
3131
extends System.ValueType
3232
implements System.Runtime.CompilerServices.IAsyncMethodBuilder
3333
```
3434

35-
## Internal Members
35+
## Internal members
3636

3737
|Name|Description|
3838
|----------|-----------------|
3939
|[ObjectIdForDebugger property](../../extensibility/debugger/asynctaskmethodbuilder-tresult-objectidfordebugger-property.md)|Gets an object that may be used to uniquely identify this builder to the debugger.|
4040
|[m_task field](../../extensibility/debugger/asynctaskmethodbuilder-tresult-m-task-field.md)|Represents the lazily initialized built task.|
4141

42-
## See Also
42+
## See also
4343
<xref:System.Runtime.CompilerServices.AsyncTaskMethodBuilder%601>
44-
[Parallel Extension Internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)
44+
[Parallel extension internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)

docs/extensibility/debugger/asyncvoidmethodbuilder-m-objectidfordebugger-field.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ manager: douge
1414
ms.workload:
1515
- "vssdk"
1616
---
17-
# AsyncVoidMethodBuilder.m_objectIdForDebugger Field
17+
# AsyncVoidMethodBuilder.m_objectIdForDebugger field
1818
Represents the lazily initialized object used by the debugger to uniquely identify this builder.
1919

2020
**Namespace:** <xref:System.Runtime.CompilerServices?displayProperty=fullName>
@@ -25,10 +25,10 @@ Represents the lazily initialized object used by the debugger to uniquely identi
2525

2626
## Syntax
2727

28-
```
28+
```csharp
2929
.field private object m_objectIdForDebugger
3030
```
3131

32-
## See Also
32+
## See also
3333
<xref:System.Runtime.CompilerServices.AsyncVoidMethodBuilder>
34-
[Parallel Extension Internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)
34+
[Parallel extension internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)

docs/extensibility/debugger/asyncvoidmethodbuilder-objectidfordebugger-property.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ manager: douge
1414
ms.workload:
1515
- "vssdk"
1616
---
17-
# AsyncVoidMethodBuilder.ObjectIdForDebugger Property
18-
Gets an object that may be used to uniquely identify this builder to the debugger.
17+
# AsyncVoidMethodBuilder.ObjectIdForDebugger property
18+
Gets an object that can be used to uniquely identify this builder to the debugger.
1919

2020
**Namespace:** <xref:System.Runtime.CompilerServices?displayProperty=fullName>
2121

@@ -31,4 +31,4 @@ private object ObjectIdForDebugger
3131

3232
## See Also
3333
<xref:System.Runtime.CompilerServices.AsyncVoidMethodBuilder>
34-
[Parallel Extension Internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)
34+
[Parallel extension internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)

docs/extensibility/debugger/asyncvoidmethodbuilder-structure-internal-members.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ manager: douge
1515
ms.workload:
1616
- "vssdk"
1717
---
18-
# AsyncVoidMethodBuilder Structure - Internal Members
18+
# AsyncVoidMethodBuilder structure - internal members
1919
This topic describes the internal members of the <xref:System.Runtime.CompilerServices.AsyncVoidMethodBuilder> class. For general information about this class, see the <xref:System.Runtime.CompilerServices.AsyncVoidMethodBuilder> reference topic.
2020

2121
**Namespace:** <xref:System.Runtime.CompilerServices?displayProperty=fullName>
@@ -26,19 +26,19 @@ This topic describes the internal members of the <xref:System.Runtime.CompilerSe
2626

2727
## Syntax
2828

29-
```
29+
```csharp
3030
.class public sequential ansi sealed beforefieldinit System.Runtime.CompilerServices.AsyncVoidMethodBuilder
3131
extends System.ValueType
3232
implements System.Runtime.CompilerServices.IAsyncMethodBuilder
3333
```
3434

35-
## Internal Members
35+
## Internal members
3636

3737
|Name|Description|
3838
|----------|-----------------|
3939
|[ObjectIdForDebugger property](../../extensibility/debugger/asyncvoidmethodbuilder-objectidfordebugger-property.md)|Gets an object that may be used to uniquely identify this builder to the debugger.|
4040
|[m_objectIdForDebugger field](../../extensibility/debugger/asyncvoidmethodbuilder-m-objectidfordebugger-field.md)|Represents the lazily initialized object used by the debugger to uniquely identify this builder.|
4141

42-
## See Also
42+
## See also
4343
<xref:System.Runtime.CompilerServices.AsyncVoidMethodBuilder>
44-
[Parallel Extension Internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)
44+
[Parallel extension internals for the .NET Framework](../../extensibility/debugger/parallel-extension-internals-for-the-dotnet-framework.md)

docs/extensibility/debugger/attaching-after-a-launch.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,36 +14,36 @@ manager: douge
1414
ms.workload:
1515
- "vssdk"
1616
---
17-
# Attaching After a Launch
18-
After a program has been launched, the debug session is ready to attach the debug engine (DE) to said program.
17+
# Attach after a launch
18+
After a program launches, the debug session is ready to attach the debug engine (DE) to said program.
1919

20-
## Design Decisions
21-
Because communication is easier within a shared address space, you must decide whether it makes more sense to facilitate the communication between the debug session and the DE, or between the DE and the program. Choose between the following:
20+
## Design decisions
21+
Because communication is easier within a shared address space, you must choose between two design approaches: set communication between the debug session and the DE. Or, set communication between the DE and the program. Choose between the following:
2222

23-
- If it makes more sense to facilitate communication between the debug session and the DE, then the debug session co-creates the DE and asks the DE to attach to the program. This leaves the debug session and DE together in one address space, and the run-time environment and program together in another.
23+
- If it makes more sense to set up the communication between the debug session and the DE, the debug session co-creates the DE and asks the DE to attach to the program. This design leaves the debug session and DE together in one address space, and the run-time environment and program together in another.
2424

25-
- If it makes more sense to facilitate communication between the DE and the program, then the run-time environment co-creates the DE. This leaves the SDM in one address space, and the DE, run-time environment, and program together in another. This is typical of a DE that is implemented with an interpreter to run scripted languages.
25+
- If it makes more sense to set up the communication between the DE and the program, the run-time environment co-creates the DE. This design leaves the SDM in one address space and the DE, run-time environment, and program together in another. This design is typical of a DE that is implemented with an interpreter to run scripted languages.
2626

2727
> [!NOTE]
2828
> How the DE attaches to the program is implementation-dependent. Communication between the DE and the program is also implementation-dependent.
2929
3030
## Implementation
31-
Programmatically, when the session debug manager (SDM) first receives the [IDebugProgram2](../../extensibility/debugger/reference/idebugprogram2.md) object that represents the program to be launched, it calls the [Attach](../../extensibility/debugger/reference/idebugprogram2-attach.md) method, passing it an [IDebugEventCallback2](../../extensibility/debugger/reference/idebugeventcallback2.md) object, which is later used to pass debug events back to the SDM. The `IDebugProgram2::Attach` method then calls the [OnAttach](../../extensibility/debugger/reference/idebugprogramnodeattach2-onattach.md) method. For more information on how the SDM receives the `IDebugProgram2` interface, see [Notifying the Port](../../extensibility/debugger/notifying-the-port.md).
31+
Programmatically, when the session debug manager (SDM) first receives the [IDebugProgram2](../../extensibility/debugger/reference/idebugprogram2.md) object that represents the program to be launched, it calls the [Attach](../../extensibility/debugger/reference/idebugprogram2-attach.md) method, passing it an [IDebugEventCallback2](../../extensibility/debugger/reference/idebugeventcallback2.md) object, which is later used to pass debug events back to the SDM. The `IDebugProgram2::Attach` method then calls the [OnAttach](../../extensibility/debugger/reference/idebugprogramnodeattach2-onattach.md) method. For more information on how the SDM receives the `IDebugProgram2` interface, see [Notifying the port](../../extensibility/debugger/notifying-the-port.md).
3232

33-
If your DE needs to run in the same address space as the program being debugged, typically because the DE is part of an interpreter running a script, the `IDebugProgramNodeAttach2::OnAttach` method returns `S_FALSE`, indicating that it completed the attach process.
33+
If your DE needs to run in the same address space as the program you're debugging: because the DE is typically part of an interpreter that's running a script, the `IDebugProgramNodeAttach2::OnAttach` method returns `S_FALSE`. The `S_FALSE` return indicates that it completed the attach process.
3434

35-
If, on the other hand, the DE runs in the address space of the SDM, the `IDebugProgramNodeAttach2::OnAttach` method returns `S_OK` or the [IDebugProgramNodeAttach2](../../extensibility/debugger/reference/idebugprogramnodeattach2.md) interface is not implemented at all on the [IDebugProgramNode2](../../extensibility/debugger/reference/idebugprogramnode2.md) object associated with the program being debugged. In this case, the [Attach](../../extensibility/debugger/reference/idebugengine2-attach.md) method is eventually called to complete the attach operation.
35+
If, however, the DE runs in the address space of the SDM: the `IDebugProgramNodeAttach2::OnAttach` method returns `S_OK`, or the [IDebugProgramNodeAttach2](../../extensibility/debugger/reference/idebugprogramnodeattach2.md) interface isn't implemented at all on the [IDebugProgramNode2](../../extensibility/debugger/reference/idebugprogramnode2.md) object associated with the program you're debugging. In this case, the [Attach](../../extensibility/debugger/reference/idebugengine2-attach.md) method is eventually called to complete the attach operation.
3636

3737
In the latter case, you must call the [GetProgramId](../../extensibility/debugger/reference/idebugprogram2-getprogramid.md) method on the `IDebugProgram2` object that was passed to the `IDebugEngine2::Attach` method, store the `GUID` in the local program object, and return this `GUID` when the `IDebugProgram2::GetProgramId` method is subsequently called on this object. The `GUID` is used to identify the program uniquely across the various debug components.
3838

39-
Note that in the case of the `IDebugProgramNodeAttach2::OnAttach` method returning `S_FALSE`, the `GUID` to use for the program is passed to that method and it is the `IDebugProgramNodeAttach2::OnAttach` method that sets the `GUID` on the local program object.
39+
In the case of the `IDebugProgramNodeAttach2::OnAttach` method returning `S_FALSE`, the `GUID` to use for the program is passed to that method and it's the `IDebugProgramNodeAttach2::OnAttach` method that sets the `GUID` on the local program object.
4040

4141
The DE is now attached to the program and ready to send any startup events.
4242

43-
## See Also
44-
[Attaching Directly to a Program](../../extensibility/debugger/attaching-directly-to-a-program.md)
45-
[Notifying the Port](../../extensibility/debugger/notifying-the-port.md)
46-
[Debugging Tasks](../../extensibility/debugger/debugging-tasks.md)
43+
## See also
44+
[Attaching directly to a program](../../extensibility/debugger/attaching-directly-to-a-program.md)
45+
[Notifying the port](../../extensibility/debugger/notifying-the-port.md)
46+
[Debugging tasks](../../extensibility/debugger/debugging-tasks.md)
4747
[IDebugEventCallback2](../../extensibility/debugger/reference/idebugeventcallback2.md)
4848
[IDebugProgram2](../../extensibility/debugger/reference/idebugprogram2.md)
4949
[Attach](../../extensibility/debugger/reference/idebugprogram2-attach.md)

0 commit comments

Comments
 (0)