Skip to content

Commit 74f036f

Browse files
author
Colin Robertson
authored
Merge pull request #1456 from msebolt/docset-changes-pr9
docset changes true false pr3
2 parents a610406 + 21d9d5f commit 74f036f

19 files changed

+47
-47
lines changed

docs/windows/comptrref-class.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -146,11 +146,11 @@ A reference to another `ComPtrRef` object, or a pointer to an anonymous type (`v
146146

147147
### Return Value
148148

149-
The first operator yields `true` if object *a* is equal to object *b*; otherwise, `false`.
149+
The first operator yields **true** if object *a* is equal to object *b*; otherwise, **false**.
150150

151-
The second and third operators yield `true` if object *a* is equal to `nullptr`; otherwise, `false`.
151+
The second and third operators yield **true** if object *a* is equal to **nullptr**; otherwise, **false**.
152152

153-
The fourth and fifth operators yield `true` if object *a* is equal to object *b*; otherwise, `false`.
153+
The fourth and fifth operators yield **true** if object *a* is equal to object *b*; otherwise, **false**.
154154

155155
### Remarks
156156

@@ -197,11 +197,11 @@ A reference to another `ComPtrRef` object, or a pointer to an anonymous object (
197197

198198
### Return Value
199199

200-
The first operator yields `true` if object *a* is not equal to object *b*; otherwise, `false`.
200+
The first operator yields **true** if object *a* is not equal to object *b*; otherwise, **false**.
201201

202-
The second and third operators yield `true` if object *a* is not equal to `nullptr`; otherwise, `false`.
202+
The second and third operators yield **true** if object *a* is not equal to **nullptr**; otherwise, **false**.
203203

204-
The fourth and fifth operators yield `true` if object *a* is not equal to object *b*; otherwise, `false`.
204+
The fourth and fifth operators yield **true** if object *a* is not equal to object *b*; otherwise, **false**.
205205

206206
### Remarks
207207

docs/windows/criticalsection-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ bool IsValid() const;
104104

105105
### Return Value
106106

107-
By default, always returns `true`.
107+
By default, always returns **true**.
108108

109109
## <a name="lock"></a>CriticalSection::Lock
110110

docs/windows/handlenulltraits-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The handle to close.
6464

6565
### Return Value
6666

67-
`true` if handle *h* closed successfully; otherwise, `false`.
67+
**true** if handle *h* closed successfully; otherwise, **false**.
6868

6969
## <a name="getinvalidvalue"></a>HANDLENullTraits::GetInvalidValue
7070

docs/windows/handlet-class.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ virtual bool InternalClose();
188188

189189
### Return Value
190190

191-
`true` if the current `HandleT` closed successfully; otherwise, `false`.
191+
**true** if the current `HandleT` closed successfully; otherwise, **false**.
192192

193193
### Remarks
194194

@@ -204,7 +204,7 @@ bool IsValid() const;
204204

205205
### Return Value
206206

207-
`true` if the `HandleT` represents a handle; otherwise, `false`.
207+
**true** if the `HandleT` represents a handle; otherwise, **false**.
208208

209209
## <a name="operator-assign"></a>HandleT::operator=
210210

docs/windows/handletraits-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The handle to close.
6464

6565
### Return Value
6666

67-
`true` if handle *h* closed successfully; otherwise, `false`.
67+
**true** if handle *h* closed successfully; otherwise, **false**.
6868

6969
## <a name="getinvalidvalue"></a>HANDLETraits::GetInvalidValue
7070

docs/windows/hstring-class.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ bool IsValid() const throw()
183183

184184
### Parameters
185185

186-
`true` if the current `HString` object is not empty; otherwise, `false`.
186+
**true** if the current `HString` object is not empty; otherwise, **false**.
187187

188188
## <a name="makereference"></a>HString::MakeReference
189189

@@ -268,7 +268,7 @@ The second parameter to compare.*rhs* can be an `HString` or `HStringReference`
268268

269269
### Return Value
270270

271-
`true` if the *lhs* and *rhs* parameters are equal; otherwise, `false`.
271+
**true** if the *lhs* and *rhs* parameters are equal; otherwise, **false**.
272272

273273
## <a name="operator-inequality"></a>HString::operator!= Operator
274274

@@ -301,7 +301,7 @@ The second parameter to compare.*rhs* can be an `HString` or `HStringReference`
301301

302302
### Return Value
303303

304-
`true` if the *lhs* and *rhs* parameters are not equal; otherwise, `false`.
304+
**true** if the *lhs* and *rhs* parameters are not equal; otherwise, **false**.
305305

306306
## <a name="operator-less-than"></a>HString::operator&lt; Operator
307307

@@ -323,7 +323,7 @@ The second parameter to compare. *rhs* can be a reference to an `HString`.
323323

324324
### Return Value
325325

326-
`true` if the *lhs* parameter is less than the *rhs* parameter; otherwise, `false`.
326+
**true** if the *lhs* parameter is less than the *rhs* parameter; otherwise, **false**.
327327

328328
## <a name="release"></a>HString::Release
329329

docs/windows/hstringreference-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ The second parameter to compare. *rhs* can be an `HStringReference` object or a
173173

174174
### Return Value
175175

176-
`true` if the *lhs* and *rhs* parameters are equal; otherwise, `false`.
176+
**true** if the *lhs* and *rhs* parameters are equal; otherwise, **false**.
177177

178178
## <a name="operator-inequality"></a>HStringReference::operator!=
179179

@@ -203,7 +203,7 @@ The second parameter to compare. *rhs* can be an `HStringReference` object or a
203203

204204
### Return Value
205205

206-
`true` if the *lhs* and *rhs* parameters are not equal; otherwise, `false`.
206+
**true** if the *lhs* and *rhs* parameters are not equal; otherwise, **false**.
207207

208208
## <a name="operator-less-than"></a>HStringReference::operator&lt;
209209

@@ -225,4 +225,4 @@ The second parameter to compare. *rhs* can be a reference to an `HStringReferen
225225

226226
### Return Value
227227

228-
`true` if the *lhs* parameter is less than the *rhs* parameter; otherwise, `false`.
228+
**true** if the *lhs* parameter is less than the *rhs* parameter; otherwise, **false**.

docs/windows/implementshelper-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ A field of flags that specifies one or more [RuntimeClassType](../windows/runtim
3232
A list of interface IDs.
3333
3434
*IsDelegateToClass*<br/>
35-
Specify `true` if the current instance of `Implements` is a base class of the first interface ID in *ILst*; otherwise, `false`.
35+
Specify **true** if the current instance of `Implements` is a base class of the first interface ID in *ILst*; otherwise, **false**.
3636
3737
## Remarks
3838

docs/windows/interfacetraits-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ If this operation is successful, *ppv* points to the interface specified by `Bas
105105

106106
### Return Value
107107

108-
`true` if this operation is successful and *ptr* is cast to a pointer to `Base`; otherwise, `false` .
108+
**true** if this operation is successful and *ptr* is cast to a pointer to `Base`; otherwise, **false**.
109109

110110
### Remarks
111111

docs/windows/isbaseofstrict-structure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The derived type.
3838
3939
Tests whether one type is the base of another.
4040
41-
The first template tests whether a type is derived from a base type, which might yield `true` or `false`. The second template tests whether a type is derived from itself, which always yields `false`.
41+
The first template tests whether a type is derived from a base type, which might yield **true** or **false**. The second template tests whether a type is derived from itself, which always yields **false**.
4242
4343
## Members
4444
@@ -70,4 +70,4 @@ static const bool value = __is_base_of(Base, Derived);
7070

7171
Indicates whether one type is the base of another.
7272

73-
`value` is `true` if type `Base` is a base class of the type `Derived`, otherwise it is `false`.
73+
`value` is **true** if type `Base` is a base class of the type `Derived`, otherwise it is **false**.

docs/windows/issame-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,4 @@ struct IsSame<T1, T1>
7878

7979
Indicates whether one type is the same as another.
8080

81-
`value` is `true` if the template parameters are the same, and `false` if the template parameters are different.
81+
`value` is **true** if the template parameters are the same, and **false** if the template parameters are different.

docs/windows/makeallocator-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ class MakeAllocator<T, true>;
4040
A type name.
4141
4242
*hasWeakReferenceSupport*<br/>
43-
`true` to allocate memory for an object that supports weak references; `false` to allocate memory for an object that doesn't support weak references.
43+
**true** to allocate memory for an object that supports weak references; **false** to allocate memory for an object that doesn't support weak references.
4444
4545
## Remarks
4646

docs/windows/module-genericreleasenotifier-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,11 @@ GenericReleaseNotifier(
8181
8282
### Parameters
8383
84-
*callback*
84+
*callback*<br/>
8585
A lambda, functor, or pointer-to-function event handler that can be invoked with the parentheses function operator (`()`).
8686
87-
*release*
88-
Specify `true` to enable calling the underlying [Module::ReleaseNotifier::Release()](../windows/module-releasenotifier-release.md) method; otherwise, specify `false`.
87+
*release*<br/>
88+
Specify **true** to enable calling the underlying [Module::ReleaseNotifier::Release()](../windows/module-releasenotifier-release.md) method; otherwise, specify **false**.
8989
9090
## <a name="genericreleasenotifier-invoke"></a>Module::GenericReleaseNotifier::Invoke
9191

docs/windows/module-methodreleasenotifier-class.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,14 @@ MethodReleaseNotifier(
9292
9393
### Parameters
9494
95-
*object*
95+
*object*<br/>
9696
An object whose member function is an event handler.
9797
98-
*method*
98+
*method*<br/>
9999
The member function of parameter *object* that is the event handler.
100100
101-
*release*
102-
Specify `true` to enable calling the underlying [Module::ReleaseNotifier::Release()](../windows/module-releasenotifier-class.md#releasenotifier-release) method; otherwise, specify `false`.
101+
*release*<br/>
102+
Specify **true** to enable calling the underlying [Module::ReleaseNotifier::Release()](../windows/module-releasenotifier-class.md#releasenotifier-release) method; otherwise, specify **false**.
103103
104104
## <a name="methodreleasenotifier-object"></a>Module::MethodReleaseNotifier::object_
105105

docs/windows/module-releasenotifier-class.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Name
3636
Name | Description
3737
------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------
3838
[Module::ReleaseNotifier::Invoke](#releasenotifier-invoke) | When implemented, calls an event handler when the last object in a module is released.
39-
[Module::ReleaseNotifier::Release](#releasenotifier-release) | Deletes the current `Module::ReleaseNotifier` object if the object was constructed with a parameter of `true`.
39+
[Module::ReleaseNotifier::Release](#releasenotifier-release) | Deletes the current `Module::ReleaseNotifier` object if the object was constructed with a parameter of **true**.
4040

4141
## Inheritance Hierarchy
4242

@@ -66,7 +66,7 @@ virtual void Invoke() = 0;
6666

6767
## <a name="releasenotifier-release"></a>Module::ReleaseNotifier::Release
6868

69-
Deletes the current `Module::ReleaseNotifier` object if the object was constructed with a parameter of `true`.
69+
Deletes the current `Module::ReleaseNotifier` object if the object was constructed with a parameter of **true**.
7070

7171
```cpp
7272
void Release() throw();

docs/windows/safeint-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ When you perform a logical comparison with a SafeInt object, the comparison is s
179179

180180
- `((uint)~0) > -1`
181181

182-
The first statement resolves to `true`, but the second statement resolves to `false`. The bitwise negation of 0 is 0xFFFFFFFF. In the second statement, the default comparison operator compares 0xFFFFFFFF to 0xFFFFFFFF and considers them to be equal. The comparison operator for the `SafeInt` class realizes that the second parameter is negative whereas the first parameter is unsigned. Therefore, although the bit representation is identical, the `SafeInt` logical operator realizes that the unsigned integer is larger than -1.
182+
The first statement resolves to **true**, but the second statement resolves to `false`. The bitwise negation of 0 is 0xFFFFFFFF. In the second statement, the default comparison operator compares 0xFFFFFFFF to 0xFFFFFFFF and considers them to be equal. The comparison operator for the `SafeInt` class realizes that the second parameter is negative whereas the first parameter is unsigned. Therefore, although the bit representation is identical, the `SafeInt` logical operator realizes that the unsigned integer is larger than -1.
183183

184184
Be careful when you use the `SafeInt` class together with the `?:` ternary operator. Consider the following line of code.
185185

docs/windows/safeint-functions.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ inline bool SafeAdd (
6565

6666
### Return Value
6767

68-
`true` if no error occurs; `false` if an error occurs.
68+
**true** if no error occurs; **false** if an error occurs.
6969

7070
## <a name="safecast"></a>SafeCast
7171

@@ -89,7 +89,7 @@ inline bool SafeCast (
8989

9090
### Return Value
9191

92-
`true` if no error occurs; `false` if an error occurs.
92+
**true** if no error occurs; **false** if an error occurs.
9393

9494
## <a name="safedivide"></a>SafeDivide
9595

@@ -117,7 +117,7 @@ inline bool SafeDivide (
117117

118118
### Return Value
119119

120-
`true` if no error occurs; `false` if an error occurs.
120+
**true** if no error occurs; **false** if an error occurs.
121121

122122
## <a name="safeequals"></a>SafeEquals
123123

@@ -141,7 +141,7 @@ inline bool SafeEquals (
141141

142142
### Return Value
143143

144-
`true` if *t* and *u* are equal; otherwise `false`.
144+
**true** if *t* and *u* are equal; otherwise **false**.
145145

146146
### Remarks
147147

@@ -169,7 +169,7 @@ inline bool SafeGreaterThan (
169169

170170
### Return Value
171171

172-
`true` if *t* is greater than *u*; otherwise `false`.
172+
**true** if *t* is greater than *u*; otherwise **false**.
173173

174174
### Remarks
175175

@@ -197,7 +197,7 @@ inline bool SafeGreaterThanEquals (
197197

198198
### Return Value
199199

200-
`true` if *t* is greater than or equal to *u*; otherwise `false`.
200+
**true** if *t* is greater than or equal to *u*; otherwise **false**.
201201

202202
### Remarks
203203

@@ -225,7 +225,7 @@ inline bool SafeLessThan (
225225

226226
### Return Value
227227

228-
`true` if *t* is less than *u*; otherwise `false`.
228+
**true** if *t* is less than *u*; otherwise **false**.
229229

230230
### Remarks
231231

@@ -253,7 +253,7 @@ inline bool SafeLessThanEquals (
253253

254254
### Return Value
255255

256-
`true` if *t* is less than or equal to *u*; otherwise `false`.
256+
**true** if *t* is less than or equal to *u*; otherwise **false**.
257257

258258
### Remarks
259259

@@ -285,7 +285,7 @@ inline bool SafeModulus (
285285

286286
### Return Value
287287

288-
`true` if no error occurs; `false` if an error occurs.
288+
**true** if no error occurs; **false** if an error occurs.
289289

290290
## <a name="safemultiply"></a>SafeMultiply
291291

@@ -337,7 +337,7 @@ inline bool SafeNotEquals (
337337

338338
### Return Value
339339

340-
`true` if *t* and *u* are not equal; otherwise `false`.
340+
**true** if *t* and *u* are not equal; otherwise **false**.
341341

342342
### Remarks
343343

@@ -369,4 +369,4 @@ inline bool SafeSubtract (
369369

370370
### Return Value
371371

372-
`true` if no error occurs; `false` if an error occurs.
372+
**true** if no error occurs; **false** if an error occurs.

docs/windows/synclockt-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ bool IsLocked() const;
9696

9797
### Return Value
9898

99-
`true` if the `SyncLockT` object is locked; otherwise, `false`.
99+
**true** if the `SyncLockT` object is locked; otherwise, **false**.
100100

101101
### Remarks
102102

docs/windows/synclockwithstatust-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Indicates whether the current `SyncLockWithStatusT` object owns a resource; that
105105

106106
### Return Value
107107

108-
`true` if the `SyncLockWithStatusT` object is locked; otherwise, `false`.
108+
**true** if the `SyncLockWithStatusT` object is locked; otherwise, **false**.
109109

110110
## <a name="status"></a>SyncLockWithStatusT::status_
111111

0 commit comments

Comments
 (0)