Skip to content

Commit c41e89c

Browse files
committed
Improve type notation in the manual.
1 parent 0f98bc4 commit c41e89c

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/UsersManual.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ In this section we will go through how the generator deals C/C++ types.
3939

4040
### Integral types
4141

42-
- char **** `byte` / `System::Byte`
43-
- bool **** `bool` / `System::Boolean`
44-
- short **** `short` / `System::Int16`
45-
- int, long **** `int` / `System::Int32`
46-
- long long **** `long` / `System::Int64`
42+
- `char` **** `byte` / `System::Byte`
43+
- `bool` **** `bool` / `System::Boolean`
44+
- `short` **** `short` / `System::Int16`
45+
- `int`, `long` **** `int` / `System::Int32`
46+
- `long long` **** `long` / `System::Int64`
4747

4848
Note: Signedness is also preserved in the conversions.
4949

@@ -57,13 +57,13 @@ In this section we will go through how the generator deals C/C++ types.
5757

5858
### Floating-point types
5959

60-
- float **** `float` / `System::Single`
61-
- double **** `double` / `System::Double`
60+
- `float` **** `float` / `System::Single`
61+
- `double` **** `double` / `System::Double`
6262

6363
### Other types
6464

65-
- wchar_t **** `char` / `System::Char`
66-
- void **** `void` / `System::Void`
65+
- `wchar_t` **** `char` / `System::Char`
66+
- `void` **** `void` / `System::Void`
6767

6868
## Derived types
6969

@@ -83,8 +83,8 @@ This is implemented by the [`DelegatesPass`](https://github.com/mono/CppSharp/bl
8383

8484
These are mapped to .NET CLR references unless:
8585

86-
- void* **** `System.IntPtr` / `System::IntPtr`
87-
- const char* **** `string` / `System::String`
86+
- `void*` **** `System.IntPtr` / `System::IntPtr`
87+
- `const char*` **** `string` / `System::String`
8888

8989
Regular non-wide strings are assumed to be ASCII by default (marshaled with .NET `Marshal.PtrToStringAnsi`).
9090
Wide strings are marshaled either as UTF-16 or UTF-32, depending on the width of `wchar_t` for the target.
@@ -117,7 +117,7 @@ to an outer enclosing context and generate a new name.
117117

118118
Some enumerations represent bitfield patterns. The generator tries to check for
119119
this with some heuristics. If there are enough values in the enum to make a good
120-
guess, we apply the [Flags] .NET attribute to the wrapper enum.
120+
guess, we apply the `[Flags]` .NET attribute to the wrapper enum.
121121

122122
This is implemented by the [`CheckFlagEnumsPass`](https://github.com/mono/CppSharp/blob/master/src/Generator/Passes/CheckFlagEnumsPass.cs) pass.
123123

0 commit comments

Comments
 (0)