Skip to content

Commit a827687

Browse files
Colin Robertsonmikeblome
Colin Robertson
authored and
mikeblome
committed
Fix common format issues (MicrosoftDocs#231)
* Fix more stray formatting. * Correct many tick format issues
1 parent b943ef8 commit a827687

348 files changed

Lines changed: 2279 additions & 2585 deletions

File tree

Some content is hidden

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

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

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -625,19 +625,15 @@ DateTimeStatus GetStatus() const throw();
625625
### Remarks
626626
The return value is defined by the **DateTimeStatus** enumerated type, which is defined within the `COleDateTime` class.
627627

628-
`enum DateTimeStatus`
629-
630-
`{`
631-
632-
`error = -1,`
633-
634-
`valid = 0,`
635-
636-
`invalid = 1, // Invalid date (out of range, etc.)`
637-
638-
`null = 2, // Literally has no value`
639-
640-
`};`
628+
```
629+
enum DateTimeStatus
630+
{
631+
error = -1,
632+
valid = 0,
633+
invalid = 1, // Invalid date (out of range, etc.)
634+
null = 2, // Literally has no value
635+
};
636+
```
641637

642638
For a brief description of these status values, see the following list:
643639

@@ -884,9 +880,7 @@ bool ParseDateTime(
884880

885881
`"8:30:00 Jan. 25, 1996"`
886882

887-
`"1/25/1996 8:30:00" // always specify the full year,`
888-
889-
`// even in a 'short date' format`
883+
`"1/25/1996 8:30:00" // always specify the full year, even in a 'short date' format`
890884

891885
Note that the locale ID will also affect whether the string format is acceptable for conversion to a date/time value.
892886

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

Lines changed: 21 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -347,15 +347,13 @@ DateTimeSpanStatus GetStatus() const throw();
347347
### Remarks
348348
The return value is defined by the **DateTimeSpanStatus** enumerated type, which is defined within the `COleDateTimeSpan` class.
349349

350-
`enum DateTimeSpanStatus{`
351-
352-
`valid = 0,`
353-
354-
`invalid = 1,`
355-
356-
`null = 2,`
357-
358-
`};`
350+
```
351+
enum DateTimeSpanStatus{
352+
valid = 0,
353+
invalid = 1,
354+
null = 2,
355+
};
356+
```
359357

360358
For a brief description of these status values, see the following list:
361359

@@ -526,15 +524,14 @@ DateTimeSpanStatus m_status;
526524
```
527525

528526
### Remarks
529-
`enum DateTimeSpanStatus{`
530-
531-
`valid = 0,`
532-
533-
`invalid = 1,`
534-
535-
`null = 2,`
536527

537-
`};`
528+
```
529+
enum DateTimeSpanStatus{
530+
valid = 0,
531+
invalid = 1,
532+
null = 2,
533+
};
534+
```
538535

539536
For a brief description of these status values, see the following list:
540537

@@ -665,15 +662,13 @@ void SetStatus(DateTimeSpanStatus status) throw();
665662
### Remarks
666663
The *Status* parameter value is defined by the **DateTimeSpanStatus** enumerated type, which is defined within the `COleDateTimeSpan` class.
667664

668-
`enum DateTimeSpanStatus{`
669-
670-
`valid = 0,`
671-
672-
`invalid = 1,`
673-
674-
`null = 2,`
675-
676-
`};`
665+
```
666+
enum DateTimeSpanStatus{
667+
valid = 0,
668+
invalid = 1,
669+
null = 2,
670+
};
671+
```
677672

678673
For a brief description of these status values, see the following list:
679674

‎docs/atl/reference/atl-ole-db-provider-wizard.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,31 +55,31 @@ This wizard creates the classes that compose an OLE DB provider.
5555
If you select this option when you created a non-attributed project, the wizard warns you that the project will be converted to an attributed project and asks you whether to continue or not.
5656

5757
**ProgID**
58-
The ProgID, or programmatic identifier, is a text string that your application can use instead of a GUID. The ProgID name has the form *Projectname*.*Coclassname*.
58+
The ProgID, or programmatic identifier, is a text string that your application can use instead of a GUID. The ProgID name has the form *Projectname.Coclassname*.
5959

6060
**Version**
6161
The version number of your provider. The default is 1.
6262

6363
**DataSource class**
64-
The name of the data source class, of the form C`Shortname`Source.
64+
The name of the data source class, of the form C*Shortname*Source.
6565

6666
**DataSource .h file**
6767
The header file for the data source class. You can edit this file's name or select an existing header file.
6868

6969
**Session class**
70-
The name of the session class, of the form C`Shortname`Session.
70+
The name of the session class, of the form C*Shortname*Session.
7171

7272
**Session .h file**
7373
The header file for the session class. You can edit this file's name or select an existing header file.
7474

7575
**Command class**
76-
The name of the command class, of the form C`Shortname`Command.
76+
The name of the command class, of the form C*Shortname*Command.
7777

7878
**Command .h file**
7979
The header file for the command class. This name cannot be edited and depends on the name of the rowset header file.
8080

8181
**Rowset class**
82-
The name of the rowset class, of the form C`Shortname`Rowset.
82+
The name of the rowset class, of the form C*Shortname*Rowset.
8383

8484
**Rowset .h file**
8585
The header file for the rowset class. You can edit this file's name or select an existing header file.

‎docs/atl/reference/cbindstatuscallback-class.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -249,15 +249,13 @@ ATL_PDATAAVAILABLE m_pFunc;
249249
### Remarks
250250
The function pointed to by `m_pFunc` is a member of your object's class and has the following syntax:
251251

252-
`void Function_Name(`
253-
254-
`CBindStatusCallback<T>* pbsc,`
255-
256-
`BYTE* pBytes,`
257-
258-
`DWORD dwSize`
259-
260-
`);`
252+
```
253+
void Function_Name(
254+
CBindStatusCallback<T>* pbsc,
255+
BYTE* pBytes,
256+
DWORD dwSize
257+
);
258+
```
261259

262260
## <a name="m_pt"></a> CBindStatusCallback::m_pT
263261
A pointer to the object requesting the asynchronous data transfer.

‎docs/atl/reference/ccomenumimpl-class.md‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -154,17 +154,14 @@ HRESULT Init(
154154

155155
The `flags` parameter allows you to specify how the enumerator should treat the array elements passed to it. `flags` can take one of the values from the **CComEnumFlags** enumeration shown below:
156156

157-
`enum CComEnumFlags`
158-
159-
`{`
160-
161-
`AtlFlagNoCopy = 0,`
162-
163-
`AtlFlagTakeOwnership = 2, // BitOwn`
164-
165-
`AtlFlagCopy = 3 // BitOwn | BitCopy`
166-
167-
`};`
157+
```
158+
enum CComEnumFlags
159+
{
160+
AtlFlagNoCopy = 0,
161+
AtlFlagTakeOwnership = 2, // BitOwn
162+
AtlFlagCopy = 3 // BitOwn | BitCopy
163+
};
164+
```
168165

169166
**AtlFlagNoCopy** means that the array's lifetime is not controlled by the enumerator. In this case, either the array will be static or the object identified by *pUnk* will be responsible for freeing the array when it's no longer needed.
170167

‎docs/atl/reference/ccomsafearray-class.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@ HRESULT MultiDimGetAt(const LONG* alIndex, T& t);
455455

456456
### Parameters
457457
`alIndex`
458-
Pointer to a vector of indexes for each dimension in the array. The leftmost (most significant) dimension is `alIndex`[0] *.*
458+
Pointer to a vector of indexes for each dimension in the array. The leftmost (most significant) dimension is `alIndex[0]`.
459459

460460
*t*
461461
A reference to the data returned.

‎docs/atl/reference/composite-control-global-functions.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,10 @@ ATLAPI_(int) AtlAxDialogBox(
9191
### Remarks
9292
To use **AtlAxDialogBox** with a dialog template that contains an ActiveX control, specify a valid **CLSID**, **APPID** or URL string as the *text* field of the **CONTROL** section of the dialog resource, along with "AtlAxWin80" as the *class name* field under the same section. The following demonstrates what a valid **CONTROL** section might look like:
9393

94-
`CONTROL "{04FE35E9-ADBC-4f1d-83FE-8FA4D1F71C7F}", IDC_TEST,`
95-
96-
`"AtlAxWin80", WS_GROUP | WS_TABSTOP, 0, 0, 100, 100`
94+
```
95+
CONTROL "{04FE35E9-ADBC-4f1d-83FE-8FA4D1F71C7F}", IDC_TEST,
96+
"AtlAxWin80", WS_GROUP | WS_TABSTOP, 0, 0, 100, 100
97+
```
9798

9899
For more information on editing resource scripts, see [How to: Open a Resource Script File in Text Format](../../windows/how-to-open-a-resource-script-file-in-text-format.md). For more information on control resource-definition statements, see [Common Control Parameters](http://msdn.microsoft.com/library/windows/desktop/aa380902) under [!INCLUDE[winSDK](../../atl/includes/winsdk_md.md)]*: SDK Tools*.
99100

‎docs/atl/reference/csecuritydesc-class.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ bool SetControl(
473473
`ControlBitsOfInterest`
474474
A **SECURITY_DESCRIPTOR_CONTROL** mask that indicates the control bits to set. For a list of the flags which can be set, see [SetSecurityDescriptorControl](http://msdn.microsoft.com/library/windows/desktop/aa379582\(v=vs.85\).aspx).
475475

476-
`ControlBitsToSe`t
476+
`ControlBitsToSet`
477477
A `SECURITY_DESCRIPTOR_CONTROL` mask that indicates the new values for the control bits specified by the `ControlBitsOfInterest` mask. This parameter can be a combination of the flags listed for the `ControlBitsOfInterest` parameter.
478478

479479
### Return Value

‎docs/atl/reference/security-global-functions.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,8 @@ inline bool AtlGetDacl(
8282
Returns true on success, false on failure.
8383

8484
### Remarks
85-
In debug builds, an assertion error will occur if either `hObject` or `pDacl` is invalid *.*
86-
87-
v
88-
85+
In debug builds, an assertion error will occur if either `hObject` or `pDacl` is invalid.
86+
8987
## <a name="atlsetdacl"></a> AtlSetDacl
9088
Call this function to set the discretionary access-control list (DACL) information of a specified object.
9189

0 commit comments

Comments
 (0)