Skip to content

Commit 3f91eaf

Browse files
author
Colin Robertson
authored
Fix gremlin chars that break compiles (#228)
* Fix gremlin chars that break compiles * Fix issues in complex, shift operators * Remove the ellipsis char
1 parent 98c9ff4 commit 3f91eaf

File tree

523 files changed

+1363
-1353
lines changed

Some content is hidden

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

523 files changed

+1363
-1353
lines changed

docs/assembler/masm/masm-for-x64-ml64-exe.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ ml64.exe is the assembler that accepts x64 assembly language. For information on
3838

3939
Inline ASM is not supported for x64. Use MASM or compiler intrinsics ([x64 (amd64) Intrinsics List](../../intrinsics/x64-amd64-intrinsics-list.md)).
4040

41-
The two workarounds are separate assembly with MASM (which supports x64 fully) and compiler intrinsics. We’ve added a lot of intrinsics to allow customers to make use of special-function instructions (e.g. privileged, bit scan/test, interlocked, etc) in as close to cross-platform a manner as possible.
41+
The two workarounds are separate assembly with MASM (which supports x64 fully) and compiler intrinsics. We’ve added a lot of intrinsics to allow customers to make use of special-function instructions (e.g. privileged, bit scan/test, interlocked, etc.) in as close to cross-platform a manner as possible.
4242

4343
## ml64-Specific Directives
4444
Use the following directives with ml64.exe:

docs/assembler/masm/ml-nonfatal-error-a2047.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ translation.priority.ht:
3939

4040
A string consisted of a delimiting pair of quotation marks and no characters within.
4141

42-
For a string to be valid, it must contain 1255 characters.
42+
For a string to be valid, it must contain 1-255 characters.
4343

4444
## See Also
4545
[ML Error Messages](../../assembler/masm/ml-error-messages.md)

docs/assembler/masm/operator-add.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The first operator returns *expression1* plus *expression2*. The second operator
4646
```
4747
4848
expression1 + expression2
49-
expression
49+
-expression
5050
```
5151

5252
## See Also

docs/assembler/masm/operator-eq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ translation.priority.ht:
3737
- "zh-tw"
3838
---
3939
# operator EQ
40-
Returns true (1) if *expression1* equals *expression2*, or returns false (0) if it does not.
40+
Returns true (-1) if *expression1* equals *expression2*, or returns false (0) if it does not.
4141

4242
## Syntax
4343

docs/assembler/masm/operator-ge.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ translation.priority.ht:
3737
- "zh-tw"
3838
---
3939
# operator GE
40-
Returns true (1) if *expression1* is greater than or equal to *expression2*, or returns false (0) if it is not.
40+
Returns true (-1) if *expression1* is greater than or equal to *expression2*, or returns false (0) if it is not.
4141

4242
## Syntax
4343

docs/assembler/masm/operator-gt.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ translation.priority.ht:
3737
- "zh-tw"
3838
---
3939
# operator GT
40-
Returns true (1) if *expression1* is greater than *expression2*, or returns false (0) if it is not.
40+
Returns true (-1) if *expression1* is greater than *expression2*, or returns false (0) if it is not.
4141

4242
## Syntax
4343

docs/assembler/masm/operator-le.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ translation.priority.ht:
3737
- "zh-tw"
3838
---
3939
# operator LE
40-
Returns true (1) if *expression1* is less than or equal to *expression2*, or returns false (0) if it is not.
40+
Returns true (-1) if *expression1* is less than or equal to *expression2*, or returns false (0) if it is not.
4141

4242
## Syntax
4343

docs/assembler/masm/operator-lt.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ translation.priority.ht:
3737
- "zh-tw"
3838
---
3939
# operator LT
40-
Returns true (1) if *expression1* is less than *expression2*, or returns false (0) if it is not.
40+
Returns true (-1) if *expression1* is less than *expression2*, or returns false (0) if it is not.
4141

4242
## Syntax
4343

docs/assembler/masm/operator-ne.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ translation.priority.ht:
3737
- "zh-tw"
3838
---
3939
# operator NE
40-
Returns true (1) if *expression1* does not equal *expression2*, or returns false (0) if it does.
40+
Returns true (-1) if *expression1* does not equal *expression2*, or returns false (0) if it does.
4141

4242
## Syntax
4343

docs/assembler/masm/operator-short.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ translation.priority.ht:
3636
- "zh-tw"
3737
---
3838
# operator SHORT
39-
Sets the type of *label* to short. All jumps to *label* must be short (within the range 128 to +127 bytes from the jump instruction to *label*).
39+
Sets the type of *label* to short. All jumps to *label* must be short (within the range -128 to +127 bytes from the jump instruction to *label*).
4040

4141
## Syntax
4242

docs/assembler/masm/operator-subtract-2.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Returns *expression1* minus *expression2*.
4444

4545
```
4646
47-
expression1 expression2
47+
expression1 - expression2
4848
```
4949

5050
## See Also

docs/atl-mfc-shared/cfixedstringt-example-of-a-custom-string-manager.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ The ATL library implements one example of a custom string manager used by class
4343

4444
- **pMgr:** A pointer to the `IAtlStringMgr` interface of a "backup string manager."
4545

46-
The constructor stores the values of `pData` and **pMgr** in their respective member variables (`m_pData` and **m_pMgr**). It then sets the length of the buffer to zero, the available length equal to the maximum size of the fixed buffer, and the reference count to 1. The reference count value indicates the buffer is locked and to use this instance of **CFixedStringMgr** as the string manager.
46+
The constructor stores the values of `pData` and **pMgr** in their respective member variables (`m_pData` and **m_pMgr**). It then sets the length of the buffer to zero, the available length equal to the maximum size of the fixed buffer, and the reference count to -1. The reference count value indicates the buffer is locked and to use this instance of **CFixedStringMgr** as the string manager.
4747

4848
Marking the buffer as locked prevents other `CStringT` instances from holding a shared reference to the buffer. If other `CStringT` instances were allowed to share the buffer it would be possible for the buffer contained by `CFixedStringT` to be deleted while other strings were still using the buffer.
4949

docs/atl-mfc-shared/reference/cimage-class.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1332,7 +1332,7 @@ LONG SetTransparentColor(LONG iTransparentColor) throw();
13321332
13331333
### Parameters
13341334
*iTransparentColor*
1335-
The index, in a color palette, of the color to set to transparent. If 1, no color is set to transparent.
1335+
The index, in a color palette, of the color to set to transparent. If -1, no color is set to transparent.
13361336
13371337
### Return Value
13381338
The index of the color previously set as transparent.

docs/atl-mfc-shared/reference/coledatetime-class.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ class COleDateTime
6464
|[COleDateTime::GetAsSystemTime](#getassystemtime)|Call this method to obtain the time in the `COleDateTime` object as a [SYSTEMTIME](http://msdn.microsoft.com/library/windows/desktop/ms724950) data structure.|
6565
|[COleDateTime::GetAsUDATE](#getasudate)|Call this method to obtain the time in the `COleDateTime` as a **UDATE** data structure.|
6666
|[COleDateTime::GetCurrentTime](#getcurrenttime)|Creates a `COleDateTime` object that represents the current time (static member function).|
67-
|[COleDateTime::GetDay](#getday)|Returns the day this `COleDateTime` object represents (1 31).|
67+
|[COleDateTime::GetDay](#getday)|Returns the day this `COleDateTime` object represents (1 - 31).|
6868
|[COleDateTime::GetDayOfWeek](#getdayofweek)|Returns the day of the week this `COleDateTime` object represents (Sunday = 1).|
6969
|[COleDateTime::GetDayOfYear](#getdayofyear)|Returns the day of the year this `COleDateTime` object represents (Jan 1 = 1).|
70-
|[COleDateTime::GetHour](#gethour)|Returns the hour this `COleDateTime` object represents (0 23).|
71-
|[COleDateTime::GetMinute](#getminute)|Returns the minute this `COleDateTime` object represents (0 59).|
72-
|[COleDateTime::GetMonth](#getmonth)|Returns the month this `COleDateTime` object represents (1 12).|
73-
|[COleDateTime::GetSecond](#getsecond)|Returns the second this `COleDateTime` object represents (0 59).|
70+
|[COleDateTime::GetHour](#gethour)|Returns the hour this `COleDateTime` object represents (0 - 23).|
71+
|[COleDateTime::GetMinute](#getminute)|Returns the minute this `COleDateTime` object represents (0 - 59).|
72+
|[COleDateTime::GetMonth](#getmonth)|Returns the month this `COleDateTime` object represents (1 - 12).|
73+
|[COleDateTime::GetSecond](#getsecond)|Returns the second this `COleDateTime` object represents (0 - 59).|
7474
|[COleDateTime::GetStatus](#getstatus)|Gets the status (validity) of this `COleDateTime` object.|
7575
|[COleDateTime::GetYear](#getyear)|Returns the year this `COleDateTime` object represents.|
7676
|[COleDateTime::ParseDateTime](#parsedatetime)|Reads a date/time value from a string and sets the value of `COleDateTime`.|
@@ -220,12 +220,12 @@ COleDateTime(const DBTIMESTAMP& dbts) throw();
220220

221221
|Date/time component|Valid range|
222222
|--------------------------|-----------------|
223-
|year|100 9999|
224-
|month|0 12|
225-
|day|0 31|
226-
|hour|0 23|
227-
|minute|0 59|
228-
|second|0 59|
223+
|year|100 - 9999|
224+
|month|0 - 12|
225+
|day|0 - 31|
226+
|hour|0 - 23|
227+
|minute|0 - 59|
228+
|second|0 - 59|
229229

230230
Note that the actual upper bound for the day component varies based on the month and year components. For details, see the **SetDate** or `SetDateTime` member functions.
231231

@@ -920,9 +920,9 @@ int SetDate(
920920

921921
|Parameter|Bounds|
922922
|---------------|------------|
923-
|`nYear`|100 9999|
924-
|`nMonth`|1 12|
925-
|`nDay`|0 31|
923+
|`nYear`|100 - 9999|
924+
|`nMonth`|1 - 12|
925+
|`nDay`|0 - 31|
926926

927927
If the day of the month overflows, it is converted to the correct day of the next month and the month and/or year is incremented accordingly. A day value of zero indicates the last day of the previous month. The behavior is the same as `SystemTimeToVariantTime`.
928928

@@ -987,12 +987,12 @@ int SetDateTime(
987987

988988
|Parameter|Bounds|
989989
|---------------|------------|
990-
|`nYear`|100 9999|
991-
|`nMonth`|1 12|
992-
|`nDay`|0 31|
993-
|`nHour`|0 23|
994-
|`nMin`|0 59|
995-
|`nSec`|0 59|
990+
|`nYear`|100 - 9999|
991+
|`nMonth`|1 - 12|
992+
|`nDay`|0 - 31|
993+
|`nHour`|0 - 23|
994+
|`nMin`|0 - 59|
995+
|`nSec`|0 - 59|
996996

997997
If the day of the month overflows, it is converted to the correct day of the next month and the month and/or year is incremented accordingly. A day value of zero indicates the last day of the previous month. The behavior is the same as [SystemTimeToVariantTime](http://msdn.microsoft.com/en-us/d9d69521-9b33-4fc5-8a1c-929f216db450).
998998

@@ -1085,9 +1085,9 @@ int SetTime(
10851085

10861086
|Parameter|Bounds|
10871087
|---------------|------------|
1088-
|`nHour`|0 23|
1089-
|`nMin`|0 59|
1090-
|`nSec`|0 59|
1088+
|`nHour`|0 - 23|
1089+
|`nMin`|0 - 59|
1090+
|`nSec`|0 - 59|
10911091

10921092
If the time value specified by the parameters is not valid, the status of this object is set to invalid and the value of this object is not changed.
10931093

docs/atl-mfc-shared/reference/coledatetimespan-class.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ LONG GetDays() const throw();
217217
The day portion of this date/time-span value.
218218

219219
### Remarks
220-
The return values from this function range between approximately 3,615,000 and 3,615,000.
220+
The return values from this function range between approximately - 3,615,000 and 3,615,000.
221221

222222
For other functions that query the value of a `COleDateTimeSpan` object, see the following member functions:
223223

@@ -249,7 +249,7 @@ LONG GetHours() const throw();
249249
The hours portion of this date/time-span value.
250250

251251
### Remarks
252-
The return values from this function range between 23 and 23.
252+
The return values from this function range between - 23 and 23.
253253

254254
For other functions that query the value of a `COleDateTimeSpan` object, see the following member functions:
255255

@@ -281,7 +281,7 @@ LONG GetMinutes() const throw();
281281
The minutes portion of this date/time-span value.
282282

283283
### Remarks
284-
The return values from this function range between 59 and 59.
284+
The return values from this function range between - 59 and 59.
285285

286286
For other functions that query the value of a `COleDateTimeSpan` object, see the following member functions:
287287

@@ -313,7 +313,7 @@ LONG GetSeconds() const throw();
313313
The seconds portion of this date/time-span value.
314314

315315
### Remarks
316-
The return values from this function range between 59 and 59.
316+
The return values from this function range between - 59 and 59.
317317

318318
For other functions that query the value of a `COleDateTimeSpan` object, see the following member functions:
319319

@@ -388,7 +388,7 @@ double GetTotalDays() const throw();
388388
This date/time-span value expressed in days. Although this function is prototyped to return a double, it will always return an integer value.
389389

390390
### Remarks
391-
The return values from this function range between approximately 3.65e6 and 3.65e6.
391+
The return values from this function range between approximately - 3.65e6 and 3.65e6.
392392

393393
For other functions that query the value of a `COleDateTimeSpan` object, see the following member functions:
394394

@@ -420,7 +420,7 @@ double GetTotalHours() const throw();
420420
This date/time-span value expressed in hours. Although this function is prototyped to return a double, it will always return an integer value.
421421

422422
### Remarks
423-
The return values from this function range between approximately 8.77e7 and 8.77e7.
423+
The return values from this function range between approximately - 8.77e7 and 8.77e7.
424424

425425
For other functions that query the value of a `COleDateTimeSpan` object, see the following member functions:
426426

@@ -452,7 +452,7 @@ double GetTotalMinutes() const throw();
452452
This date/time-span value expressed in minutes. Although this function is prototyped to return a double, it will always return an integer value.
453453

454454
### Remarks
455-
The return values from this function range between approximately 5.26e9 and 5.26e9.
455+
The return values from this function range between approximately - 5.26e9 and 5.26e9.
456456

457457
For other functions that query the value of a `COleDateTimeSpan` object, see the following member functions:
458458

@@ -484,7 +484,7 @@ double GetTotalSeconds() const throw();
484484
This date/time-span value expressed in seconds. Although this function is prototyped to return a double, it will always return an integer value.
485485

486486
### Remarks
487-
The return values from this function range between approximately 3.16e11 to 3.16e11.
487+
The return values from this function range between approximately - 3.16e11 to 3.16e11.
488488

489489
For other functions that query the value of a `COleDateTimeSpan` object, see the following member functions:
490490

docs/atl-mfc-shared/reference/csimplestringt-class.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ PXSTR GetBuffer();
409409

410410
The buffer memory is automatically freed when the `CSimpleStringT` object is destroyed.
411411

412-
If you keep track of the string length yourself, you should not append the terminating null character. However, you must specify the final string length when you release the buffer with `ReleaseBuffer`. If you do append a terminating null character, you should pass 1 (the default) for the length. `ReleaseBuffer` then determines the buffer length.
412+
If you keep track of the string length yourself, you should not append the terminating null character. However, you must specify the final string length when you release the buffer with `ReleaseBuffer`. If you do append a terminating null character, you should pass -1 (the default) for the length. `ReleaseBuffer` then determines the buffer length.
413413

414414
If there is insufficient memory to satisfy the `GetBuffer` request, this method throws a CMemoryException*.
415415

@@ -449,7 +449,7 @@ PXSTR GetBufferSetLength(int nLength);
449449
450450
The buffer memory is automatically freed when the `CSimpleStringT` object is destroyed.
451451
452-
If you keep track of the string length yourself, do not not append the terminating null character. You must specify the final string length when you release the buffer by using `ReleaseBuffer`. If you do append a terminating null character when you call `ReleaseBuffer`, pass 1 (the default) for the length to `ReleaseBuffer`, and `ReleaseBuffer` will perform a `strlen` on the buffer to determine its length.
452+
If you keep track of the string length yourself, do not not append the terminating null character. You must specify the final string length when you release the buffer by using `ReleaseBuffer`. If you do append a terminating null character when you call `ReleaseBuffer`, pass -1 (the default) for the length to `ReleaseBuffer`, and `ReleaseBuffer` will perform a `strlen` on the buffer to determine its length.
453453
454454
For more information about reference counting, see the following articles:
455455
@@ -566,7 +566,7 @@ PXSTR LockBuffer();
566566
A pointer to a `CSimpleStringT` object or a null-terminated string.
567567

568568
### Remarks
569-
Call this method to lock the buffer of the `CSimpleStringT` object. By calling `LockBuffer`, you create a copy of the string, with a 1 for the reference count. When the reference count value is -1, the string in the buffer is considered to be in a "locked" state. While in a locked state, the string is protected in two ways:
569+
Call this method to lock the buffer of the `CSimpleStringT` object. By calling `LockBuffer`, you create a copy of the string, with a -1 for the reference count. When the reference count value is -1, the string in the buffer is considered to be in a "locked" state. While in a locked state, the string is protected in two ways:
570570

571571
- No other string can get a reference to the data in the locked string, even if that string is assigned to the locked string.
572572

docs/atl-mfc-shared/reference/cstringt-class.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ int FindOneOf(PCXSTR pszCharSet) const throw();
579579
String containing characters for matching.
580580

581581
### Return Value
582-
The zero-based index of the first character in this string that is also in `pszCharSet`; 1 if there is no match.
582+
The zero-based index of the first character in this string that is also in `pszCharSet`; -1 if there is no match.
583583

584584
### Remarks
585585
Finds the first occurrence of any of the characters in `pszCharSet`.
@@ -1247,7 +1247,7 @@ int ReverseFind(XCHAR ch) const throw();
12471247
The character to search for.
12481248

12491249
### Return Value
1250-
The zero-based index of the last character in this `CStringT` object that matches the requested character, or 1 if the character is not found.
1250+
The zero-based index of the last character in this `CStringT` object that matches the requested character, or -1 if the character is not found.
12511251

12521252
### Remarks
12531253
The function is similar to the run-time function `strrchr`.

docs/atl-mfc-shared/reference/ctime-class.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,8 @@ class CTime
7676

7777
|||
7878
|-|-|
79-
|[operator + ](#operator_add_-)|These operators add and subtract `CTimeSpan` and `CTime` objects.|
80-
|[operator +=, =](#operator_add_eq_-_eq)|These operators add and subtract a `CTimeSpan` object to and from this `CTime` object.|
79+
|[operator + -](#operator_add_-)|These operators add and subtract `CTimeSpan` and `CTime` objects.|
80+
|[operator +=, -=](#operator_add_eq_-_eq)|These operators add and subtract a `CTimeSpan` object to and from this `CTime` object.|
8181
|[operator =](#operator_eq)|The assignment operator.|
8282
|[operator ==, < , etc.](#ctime_comparison_operators)|Comparison operators.|
8383

@@ -185,9 +185,9 @@ CTime(const DBTIMESTAMP& dbts,int nDST = -1) throw();
185185

186186
|Component|Range|
187187
|---------------|-----------|
188-
|`nYear`|19703000|
189-
|`nMonth`|112|
190-
|`nDay`|131|
188+
|`nYear`|1970-3000|
189+
|`nMonth`|1-12|
190+
|`nDay`|1-31|
191191
|`nHour`|0-23|
192192
|`nMin`|0-59|
193193
|`nSec`|0-59|
@@ -261,7 +261,7 @@ CString FormatGmt(UINT nFormatID) const;
261261
See the example for [CTime::Format](#format).
262262

263263
## <a name="getasdbtimestamp"></a> CTime::GetAsDBTIMESTAMP
264-
Call this member function to convert the time information stored in the `CTime` object to a Win32compatible DBTIMESTAMP structure.
264+
Call this member function to convert the time information stored in the `CTime` object to a Win32-compatible DBTIMESTAMP structure.
265265

266266
```
267267
bool GetAsDBTIMESTAMP(DBTIMESTAMP& dbts) const throw();
@@ -281,7 +281,7 @@ bool GetAsDBTIMESTAMP(DBTIMESTAMP& dbts) const throw();
281281
[!code-cpp[NVC_ATLMFC_Utilities#150](../../atl-mfc-shared/codesnippet/cpp/ctime-class_4.cpp)]
282282

283283
## <a name="getassystemtime"></a> CTime::GetAsSystemTime
284-
Call this member function to convert the time information stored in the `CTime` object to a Win32compatible [SYSTEMTIME](http://msdn.microsoft.com/library/windows/desktop/ms724950) structure.
284+
Call this member function to convert the time information stored in the `CTime` object to a Win32-compatible [SYSTEMTIME](http://msdn.microsoft.com/library/windows/desktop/ms724950) structure.
285285

286286
```
287287
bool GetAsSystemTime(SYSTEMTIME& st) const throw();

0 commit comments

Comments
 (0)