Skip to content

Commit 9d85dd9

Browse files
Youssef1313mairaw
authored andcommitted
Fix heading jump, make parameters as list (#16685)
* Fixes * Feedback * Update functiontailcall2-function.md * Update icorprofilercallback-jitcompilationfinished-method.md * Update icorprofilerinfo8-getdynamicfunctioninfo-method.md * Update icorprofilerinfo8-getfunctionfromip3-method.md * Update icorprofilercallback-initialize-method.md * Update icorprofilerinfo8-getdynamicfunctioninfo-method.md
1 parent 7037626 commit 9d85dd9

File tree

53 files changed

+515
-358
lines changed

Some content is hidden

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

53 files changed

+515
-358
lines changed

docs/framework/unmanaged-api/profiling/functionenter-function.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,12 @@ void __stdcall FunctionEnter (
2929
);
3030
```
3131

32-
## Parameters
33-
`funcID`
34-
[in] The identifier of the function to which control is passed.
35-
32+
## Parameters
33+
34+
- `funcID`
35+
36+
\[in] The identifier of the function to which control is passed.
37+
3638
## Remarks
3739
The `FunctionEnter` function is a callback; you must implement it. The implementation must use the `__declspec`(`naked`) storage-class attribute.
3840

docs/framework/unmanaged-api/profiling/functionenter2-function.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,28 @@ void __stdcall FunctionEnter2 (
2929
);
3030
```
3131

32-
## Parameters
33-
`funcId`
34-
[in] The identifier of the function to which control is passed.
35-
36-
`clientData`
37-
[in] The remapped function identifier, which the profiler previously specified by using the [FunctionIDMapper](../../../../docs/framework/unmanaged-api/profiling/functionidmapper-function.md) function.
38-
39-
`func`
40-
[in] A `COR_PRF_FRAME_INFO` value that points to information about the stack frame.
41-
42-
The profiler should treat this as an opaque handle that can be passed back to the execution engine in the [ICorProfilerInfo2::GetFunctionInfo2](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md) method.
32+
## Parameters
33+
34+
- `funcId`
35+
36+
\[in] The identifier of the function to which control is passed.
37+
38+
- `clientData`
39+
40+
\[in] The remapped function identifier, which the profiler previously specified by using the [FunctionIDMapper](../../../../docs/framework/unmanaged-api/profiling/functionidmapper-function.md) function.
4341

44-
`argumentInfo`
45-
[in] A pointer to a [COR_PRF_FUNCTION_ARGUMENT_INFO](../../../../docs/framework/unmanaged-api/profiling/cor-prf-function-argument-info-structure.md) structure that specifies the locations in memory of the function's arguments.
42+
- `func`
43+
44+
\[in] A `COR_PRF_FRAME_INFO` value that points to information about the stack frame.
4645

47-
In order to access argument information, the `COR_PRF_ENABLE_FUNCTION_ARGS` flag must be set. The profiler can use the [ICorProfilerInfo::SetEventMask](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo-seteventmask-method.md) method to set the event flags.
46+
The profiler should treat this as an opaque handle that can be passed back to the execution engine in the [ICorProfilerInfo2::GetFunctionInfo2](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md) method.
4847

48+
- `argumentInfo`
49+
50+
\[in] A pointer to a [COR_PRF_FUNCTION_ARGUMENT_INFO](../../../../docs/framework/unmanaged-api/profiling/cor-prf-function-argument-info-structure.md) structure that specifies the locations in memory of the function's arguments.
51+
52+
In order to access argument information, the `COR_PRF_ENABLE_FUNCTION_ARGS` flag must be set. The profiler can use the [ICorProfilerInfo::SetEventMask](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo-seteventmask-method.md) method to set the event flags.
53+
4954
## Remarks
5055
The values of the `func` and `argumentInfo` parameters are not valid after the `FunctionEnter2` function returns because the values may change or be destroyed.
5156

docs/framework/unmanaged-api/profiling/functionenter3-function.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,12 @@ Notifies the profiler that control is being passed to a function.
2424
void __stdcall FunctionEnter3(FunctionOrRemappedID functionOrRemappedID);
2525
```
2626
27-
## Parameters
28-
`functionOrRemappedID`
29-
[in] The identifier of the function to which control is passed.
30-
27+
## Parameters
28+
29+
- `functionOrRemappedID`
30+
31+
\[in] The identifier of the function to which control is passed.
32+
3133
## Remarks
3234
The `FunctionEnter3` callback function notifies the profiler as functions are being called, but does not support argument inspection. Use the [ICorProfilerInfo3::SetEnterLeaveFunctionHooks3 method](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo3-setenterleavefunctionhooks3-method.md) to register your implementation of this function.
3335

docs/framework/unmanaged-api/profiling/functionenter3withinfo-function.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,16 @@ void __stdcall FunctionEnter3WithInfo(
2626
[in] COR_PRF_ELT_INFO eltInfo);
2727
```
2828
29-
## Parameters
30-
`functionIDOrClientID`
31-
[in] The identifier of the function to which control is passed.
32-
33-
`eltInfo`
34-
[in] An opaque handle that represents information about a given stack frame. This handle is valid only during the callback to which it is passed.
35-
29+
## Parameters
30+
31+
- `functionIDOrClientID`
32+
33+
\[in] The identifier of the function to which control is passed.
34+
35+
- `eltInfo`
36+
37+
\[in] An opaque handle that represents information about a given stack frame. This handle is valid only during the callback to which it is passed.
38+
3639
## Remarks
3740
The `FunctionEnter3WithInfo` callback method notifies the profiler as functions are called, and enables the profiler to use the [ICorProfilerInfo3::GetFunctionEnter3Info method](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo3-getfunctionenter3info-method.md) to inspect argument values. To access argument information, the `COR_PRF_ENABLE_FUNCTION_ARGS` flag has to be set. The profiler can use the [ICorProfilerInfo::SetEventMask method](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo-seteventmask-method.md) to set the event flags, and then use the [ICorProfilerInfo3::SetEnterLeaveFunctionHooks3WithInfo method](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo3-setenterleavefunctionhooks3withinfo-method.md) to register your implementation of this function.
3841

docs/framework/unmanaged-api/profiling/functionidmapper-function.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,16 @@ UINT_PTR __stdcall FunctionIDMapper (
2727
);
2828
```
2929

30-
## Parameters
31-
`funcId`
32-
[in] The function identifier to be remapped.
33-
34-
`pbHookFunction`
35-
[out] A pointer to a value that the profiler sets to `true` if it wants to receive `FunctionEnter2`, `FunctionLeave2`, and `FunctionTailcall2` callbacks; otherwise, it sets this value to `false`.
36-
30+
## Parameters
31+
32+
- `funcId`
33+
34+
\[in] The function identifier to be remapped.
35+
36+
- `pbHookFunction`
37+
38+
\[out] A pointer to a value that the profiler sets to `true` if it wants to receive `FunctionEnter2`, `FunctionLeave2`, and `FunctionTailcall2` callbacks; otherwise, it sets this value to `false`.
39+
3740
## Return Value
3841
The profiler returns a value that the execution engine uses as an alternative function identifier. The return value cannot be null unless `false` is returned in `pbHookFunction`. Otherwise, a null return value will produce unpredictable results, including possibly halting the process.
3942

docs/framework/unmanaged-api/profiling/functionidmapper2-function.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,20 @@ UINT_PTR __stdcall FunctionIDMapper2 (
2828
);
2929
```
3030

31-
## Parameters
32-
`funcId`
33-
[in] The function identifier to be remapped.
34-
35-
`clientData`
36-
[in] A pointer to data that is used to disambiguate among runtimes.
37-
38-
`pbHookFunction`
39-
[out] A pointer to a value that the profiler sets to `true` if it wants to receive `FunctionEnter3`, `FunctionLeave3`, and `FunctionTailcall3`, or `FunctionEnter3WithInfo`, `FunctionLeave3WithInfo`, and `FunctionTailcall3WithInfo` callbacks; otherwise, it sets this value to `false`.
40-
31+
## Parameters
32+
33+
- `funcId`
34+
35+
\[in] The function identifier to be remapped.
36+
37+
- `clientData`
38+
39+
\[in] A pointer to data that is used to disambiguate among runtimes.
40+
41+
- `pbHookFunction`
42+
43+
\[out] A pointer to a value that the profiler sets to `true` if it wants to receive `FunctionEnter3`, `FunctionLeave3`, and `FunctionTailcall3`, or `FunctionEnter3WithInfo`, `FunctionLeave3WithInfo`, and `FunctionTailcall3WithInfo` callbacks; otherwise, it sets this value to `false`.
44+
4145
## Return Value
4246
The profiler returns a value that the execution engine uses as an alternative function identifier. The return value cannot be null unless `false` is returned in `pbHookFunction`. Otherwise, a null return value produces unpredictable results, including possibly halting the process.
4347

docs/framework/unmanaged-api/profiling/functionleave-function.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,12 @@ void __stdcall FunctionLeave (
2929
);
3030
```
3131

32-
## Parameters
33-
`funcID`
34-
[in] The identifier of the function that is returning.
35-
32+
## Parameters
33+
34+
- `funcID`
35+
36+
\[in] The identifier of the function that is returning.
37+
3638
## Remarks
3739
The `FunctionLeave` function is a callback; you must implement it. The implementation must use the `__declspec`(`naked`) storage-class attribute.
3840

docs/framework/unmanaged-api/profiling/functionleave2-function.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,23 +29,28 @@ void __stdcall FunctionLeave2 (
2929
);
3030
```
3131

32-
## Parameters
33-
`funcId`
34-
[in] The identifier of the function that is returning.
35-
36-
`clientData`
37-
[in] The remapped function identifier, which the profiler previously specified via the [FunctionIDMapper](../../../../docs/framework/unmanaged-api/profiling/functionidmapper-function.md) function.
38-
39-
`func`
40-
[in] A `COR_PRF_FRAME_INFO` value that points to information about the stack frame.
41-
42-
The profiler should treat this as an opaque handle that can be passed back to the execution engine in the [ICorProfilerInfo2::GetFunctionInfo2](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md) method.
43-
44-
`retvalRange`
45-
[in] A pointer to a [COR_PRF_FUNCTION_ARGUMENT_RANGE](../../../../docs/framework/unmanaged-api/profiling/cor-prf-function-argument-range-structure.md) structure that specifies the memory location of the function's return value.
46-
47-
In order to access return value information, the `COR_PRF_ENABLE_FUNCTION_RETVAL` flag must be set. The profiler can use the [ICorProfilerInfo::SetEventMask](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo-seteventmask-method.md) method to set the event flags.
32+
## Parameters
33+
34+
- `funcId`
35+
36+
\[in] The identifier of the function that is returning.
37+
38+
- `clientData`
39+
40+
\[in] The remapped function identifier, which the profiler previously specified via the [FunctionIDMapper](../../../../docs/framework/unmanaged-api/profiling/functionidmapper-function.md) function.
41+
42+
- `func`
43+
44+
\[in] A `COR_PRF_FRAME_INFO` value that points to information about the stack frame.
45+
46+
The profiler should treat this as an opaque handle that can be passed back to the execution engine in the [ICorProfilerInfo2::GetFunctionInfo2](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo2-getfunctioninfo2-method.md) method.
4847

48+
- `retvalRange`
49+
50+
\[in] A pointer to a [COR_PRF_FUNCTION_ARGUMENT_RANGE](../../../../docs/framework/unmanaged-api/profiling/cor-prf-function-argument-range-structure.md) structure that specifies the memory location of the function's return value.
51+
52+
In order to access return value information, the `COR_PRF_ENABLE_FUNCTION_RETVAL` flag must be set. The profiler can use the [ICorProfilerInfo::SetEventMask](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo-seteventmask-method.md) method to set the event flags.
53+
4954
## Remarks
5055
The values of the `func` and `retvalRange` parameters are not valid after the `FunctionLeave2` function returns because the values may change or be destroyed.
5156

docs/framework/unmanaged-api/profiling/functionleave3-function.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,10 @@ void __stdcall FunctionLeave3(FunctionOrRemappedID functionOrRemappedID);
2525
```
2626
2727
## Parameters
28-
`functionOrRemappedID`
29-
[in] The identifier of the function from which control is returned.
28+
29+
- `functionOrRemappedID`
30+
31+
\[in] The identifier of the function from which control is returned.
3032
3133
## Remarks
3234
The `FunctionLeave3` callback function notifies the profiler as functions are being called, but does not support return value inspection. Use the [ICorProfilerInfo3::SetEnterLeaveFunctionHooks3 method](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo3-setenterleavefunctionhooks3-method.md) to register your implementation of this function.

docs/framework/unmanaged-api/profiling/functionleave3withinfo-function.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,16 @@ void __stdcall FunctionLeave3WithInfo(
2626
[in] COR_PRF_ELT_INFO eltInfo);
2727
```
2828
29-
## Parameters
30-
`functionIDOrClientID`
31-
[in] The identifier of the function from which control is returned.
32-
33-
`eltInfo`
34-
[in] An opaque handle that represents information about a given stack frame. This handle is valid only during the callback to which it is passed.
35-
29+
## Parameters
30+
31+
- `functionIDOrClientID`
32+
33+
\[in] The identifier of the function from which control is returned.
34+
35+
- `eltInfo`
36+
37+
\[in] An opaque handle that represents information about a given stack frame. This handle is valid only during the callback to which it is passed.
38+
3639
## Remarks
3740
The `FunctionLeave3WithInfo` callback method notifies the profiler as functions are called, and allows the profiler to use the [ICorProfilerInfo3::GetFunctionLeave3Info method](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo3-getfunctionleave3info-method.md) to inspect the return value. To access return value information, the `COR_PRF_ENABLE_FUNCTION_RETVAL` flag has to be set. The profiler can use the [ICorProfilerInfo::SetEventMask method](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo-seteventmask-method.md) to set the event flags, and then use the [ICorProfilerInfo3::SetEnterLeaveFunctionHooks3WithInfo method](../../../../docs/framework/unmanaged-api/profiling/icorprofilerinfo3-setenterleavefunctionhooks3withinfo-method.md) to register your implementation of this function.
3841

0 commit comments

Comments
 (0)