Skip to content

Commit 37366c8

Browse files
author
Colin Robertson
committed
Fix some tick-style parameters. Only some.
1 parent a7459a6 commit 37366c8

File tree

99 files changed

+272
-249
lines changed

Some content is hidden

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

99 files changed

+272
-249
lines changed

‎docs/assembler/arm/arm-assembler-directives.md‎

Lines changed: 77 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -16,92 +16,113 @@ For the most part, the Microsoft ARM assembler uses the ARM assembly language, w
1616

1717
## Microsoft Implementations of ARM Assembly Directives
1818

19-
`AREA`<br/>
20-
The Microsoft ARM assembler supports these `AREA` attributes: `ALIGN`, `CODE`, `CODEALIGN`, `DATA`, `NOINIT`, `READONLY`, `READWRITE`, `THUMB`, `ARM`.
19+
- AREA
2120

22-
All except `THUMB` and `ARM` work as documented in the [ARM Compiler armasm Reference Guide](http://infocenter.arm.com/help/topic/com.arm.doc.dui0802b/index.html).
21+
The Microsoft ARM assembler supports these `AREA` attributes: `ALIGN`, `CODE`, `CODEALIGN`, `DATA`, `NOINIT`, `READONLY`, `READWRITE`, `THUMB`, `ARM`.
2322

24-
In the Microsoft ARM assembler, `THUMB` indicates that a `CODE` section contains Thumb code, and is the default for `CODE` sections. `ARM` indicates that the section contains ARM code.
23+
All except `THUMB` and `ARM` work as documented in the [ARM Compiler armasm Reference Guide](http://infocenter.arm.com/help/topic/com.arm.doc.dui0802b/index.html).
2524

26-
`ATTR`<br/>
27-
Not supported.
25+
In the Microsoft ARM assembler, `THUMB` indicates that a `CODE` section contains Thumb code, and is the default for `CODE` sections. `ARM` indicates that the section contains ARM code.
2826

29-
`CODE16`<br/>
30-
Not supported because it implies pre-UAL Thumb syntax, which the Microsoft ARM assembler does not allow. Use the `THUMB` directive instead, along with UAL syntax.
27+
- ATTR
3128

32-
`COMMON`<br/>
33-
Specification of an alignment for the common region is not supported.
29+
Not supported.
3430

35-
`DCDO`<br/>
36-
Not supported.
31+
- CODE16
3732

38-
`DN`, `QN`, `SN`<br/>
39-
Specification of a type or a lane on the register alias is not supported.
33+
Not supported because it implies pre-UAL Thumb syntax, which the Microsoft ARM assembler does not allow. Use the `THUMB` directive instead, along with UAL syntax.
4034

41-
`ENTRY`<br/>
42-
Not supported.
35+
- COMMON
4336

44-
`EQU`<br/>
45-
Specification of a type for the defined symbol is not supported.
37+
Specification of an alignment for the common region is not supported.
4638

47-
`EXPORT` and `GLOBAL`<br/>
48-
Specifies exports using this syntax:
39+
- DCDO
4940

50-
> **EXPORT**|**GLOBAL** <em>sym</em>{**[**<em>type</em>**]**}
41+
Not supported.
5142

52-
*sym* is the symbol to be exported. [*type*], if specified, can be either `[DATA]` to indicate that the symbol points to data or `[FUNC]` to indicate that the symbol points to code. `GLOBAL` is a synonym for `EXPORT`.
43+
- `DN`, `QN`, `SN`
5344

54-
`EXPORTAS`<br/>
55-
Not supported.
45+
Specification of a type or a lane on the register alias is not supported.
5646

57-
`FRAME`<br/>
58-
Not supported.
47+
- ENTRY
5948

60-
`FUNCTION` and `PROC`<br/>
61-
Although the assembly syntax supports the specification of a custom calling convention on procedures by listing the registers that are caller-save and those that are callee-save, the Microsoft ARM assembler accepts the syntax but ignores the register lists. The debug information that is produced by the assembler supports only the default calling convention.
49+
Not supported.
6250

63-
`IMPORT` and `EXTERN`<br/>
64-
Specifies imports using this syntax:
51+
- EQU
6552

66-
> **IMPORT**|**EXTERN** *sym*{**, WEAK** *alias*{**, TYPE** *t*}}
53+
Specification of a type for the defined symbol is not supported.
6754

68-
*sym* is the name of the symbol to be imported.
55+
- `EXPORT` and `GLOBAL`
6956

70-
If `WEAK` *alias* is specified, it indicates that *sym* is a weak external. If no definition for it is found at link time, then all references to it bind instead to *alias*.
57+
Specifies exports using this syntax:
7158

72-
If `TYPE` *t* is specified, then *t* indicates how the linker should attempt to resolve *sym*. These values for *t* are possible:
59+
> **EXPORT**|**GLOBAL** <em>sym</em>{**[**<em>type</em>**]**}
7360
74-
|Value|Description|
75-
|-|-|
76-
|1|Do not perform a library search for *sym*|
77-
|2|Perform a library search for *sym*|
78-
|3|*sym* is an alias for *alias* (default)|
61+
*sym* is the symbol to be exported. [*type*], if specified, can be either `[DATA]` to indicate that the symbol points to data or `[FUNC]` to indicate that the symbol points to code. `GLOBAL` is a synonym for `EXPORT`.
7962

80-
`EXTERN` is a synonym for `IMPORT`, except that *sym* is imported only if there are references to it in the current assembly.
63+
- EXPORTAS
8164

82-
`MACRO`<br/>
83-
The use of a variable to hold the condition code of a macro is not supported. Default values for macro parameters are not supported.
65+
Not supported.
8466

85-
`NOFP`<br/>
86-
Not supported.
67+
- FRAME
8768

88-
`OPT`, `TTL`, `SUBT`<br/>
89-
Not supported because the Microsoft ARM assembler does not produce listings.
69+
Not supported.
9070

91-
`PRESERVE8`<br/>
92-
Not supported.
71+
- `FUNCTION` and `PROC`
9372

94-
`RELOC`<br/>
95-
`RELOC n` can only follow an instruction or a data definition directive. There is no "anonymous symbol" that can be relocated.
73+
Although the assembly syntax supports the specification of a custom calling convention on procedures by listing the registers that are caller-save and those that are callee-save, the Microsoft ARM assembler accepts the syntax but ignores the register lists. The debug information that is produced by the assembler supports only the default calling convention.
9674

97-
`REQUIRE`<br/>
98-
Not supported.
75+
- `IMPORT` and `EXTERN`
9976

100-
`REQUIRE8`<br/>
101-
Not supported.
77+
Specifies imports using this syntax:
10278

103-
`THUMBX`<br/>
104-
Not supported because the Microsoft ARM assembler does not support the Thumb-2EE instruction set.
79+
> **IMPORT**|**EXTERN** *sym*{**, WEAK** *alias*{**, TYPE** *t*}}
80+
81+
*sym* is the name of the symbol to be imported.
82+
83+
If `WEAK` *alias* is specified, it indicates that *sym* is a weak external. If no definition for it is found at link time, then all references to it bind instead to *alias*.
84+
85+
If `TYPE` *t* is specified, then *t* indicates how the linker should attempt to resolve *sym*. These values for *t* are possible:
86+
87+
|Value|Description|
88+
|-|-|
89+
|1|Do not perform a library search for *sym*|
90+
|2|Perform a library search for *sym*|
91+
|3|*sym* is an alias for *alias* (default)|
92+
93+
`EXTERN` is a synonym for `IMPORT`, except that *sym* is imported only if there are references to it in the current assembly.
94+
95+
- MACRO
96+
97+
The use of a variable to hold the condition code of a macro is not supported. Default values for macro parameters are not supported.
98+
99+
- NOFP
100+
101+
Not supported.
102+
103+
- `OPT`, `TTL`, `SUBT`
104+
105+
Not supported because the Microsoft ARM assembler does not produce listings.
106+
107+
- PRESERVE8
108+
109+
Not supported.
110+
111+
- RELOC
112+
113+
`RELOC n` can only follow an instruction or a data definition directive. There is no "anonymous symbol" that can be relocated.
114+
115+
- REQUIRE
116+
117+
Not supported.
118+
119+
- REQUIRE8
120+
121+
Not supported.
122+
123+
- THUMBX
124+
125+
Not supported because the Microsoft ARM assembler does not support the Thumb-2EE instruction set.
105126

106127
## See also
107128

‎docs/c-runtime-library/except-handler3.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,17 +29,18 @@ int _except_handler3(
2929
);
3030
```
3131

32-
#### Parameters
33-
`exception_record`<br/>
32+
#### Parameters
33+
34+
*exception_record*<br/>
3435
[in] Information about the specific exception.
3536

36-
`registration`<br/>
37+
*registration*<br/>
3738
[in] The record that indicates which scope table should be used to find the exception handler.
3839

39-
`context`<br/>
40+
*context*<br/>
4041
[in] Reserved.
4142

42-
`dispatcher`<br/>
43+
*dispatcher*<br/>
4344
[in] Reserved.
4445

4546
## Return Value

‎docs/c-runtime-library/execute-onexit-table-initialize-onexit-table-register-onexit-function.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,12 @@ int _execute_onexit_table(
3434
);
3535
```
3636

37-
#### Parameters
38-
`table`<br/>
37+
#### Parameters
38+
39+
*table*<br/>
3940
[in, out] Pointer to the onexit function table.
4041

41-
`function`<br/>
42+
*function*<br/>
4243
[in] Pointer to a function to add to the onexit function table.
4344

4445
## Return Value

‎docs/c-runtime-library/local-unwind2.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ void _local_unwind2(
2828
```
2929

3030
#### Parameters
31-
`xr`<br/>
31+
*xr*<br/>
3232
[in] A registration record that is associated with one scope table.
3333

34-
`stop`<br/>
34+
*stop*<br/>
3535
[in] The lexical level that indicates where `_local_unwind2` should stop.
3636

3737
## Remarks

‎docs/c-runtime-library/lock.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ void __cdecl _lock
3030
```
3131

3232
#### Parameters
33-
`locknum`<br/>
33+
*locknum*<br/>
3434
[in] The identifier of the lock to acquire.
3535

3636
## Remarks

‎docs/c-runtime-library/set-output-format.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ unsigned int _set_output_format(
3030
```
3131

3232
#### Parameters
33-
`format`<br/>
33+
*format*<br/>
3434
[in] An value representing the format to use.
3535

3636
## Return value

‎docs/c-runtime-library/setjmp3.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ int _setjmp3(
2929
```
3030

3131
#### Parameters
32-
`env`<br/>
32+
*env*<br/>
3333
[out] Address of the buffer for storing state information.
3434

35-
`count`<br/>
35+
*count*<br/>
3636
[in] The number of additional `DWORD`s of information that are stored in the `optional parameters`.
3737

38-
`optional parameters`<br/>
38+
*optional parameters*<br/>
3939
[in] Additional data pushed down by the `setjmp` intrinsic. The first `DWORD` is a function pointer that is used to unwind extra data and return to a nonvolatile register state. The second `DWORD` is the try level to be restored. Any further data is saved in the generic data array in the `jmp_buf`.
4040

4141
## Return Value

‎docs/c-runtime-library/unlock.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ void __cdecl _unlock(
3030
```
3131

3232
#### Parameters
33-
`locknum`<br/>
33+
*locknum*<br/>
3434
[in] The identifier of the lock to release.
3535

3636
## Requirements

‎docs/dotnet/marshal-as.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To_Type marshal_as<To_Type>(
2424
```
2525

2626
#### Parameters
27-
`input`<br/>
27+
*input*<br/>
2828
[in] The value that you want to marshal to a `To_Type` variable.
2929

3030
## Return Value

‎docs/dotnet/marshal-context-marshal-as.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To_Type marshal_as<To_Type>(
2424
```
2525

2626
#### Parameters
27-
`input`<br/>
27+
*input*<br/>
2828
[in] The value that you want to marshal to a `To_Type` variable.
2929

3030
## Return Value

0 commit comments

Comments
 (0)