Skip to content

Commit 68f17fa

Browse files
author
Michael Blome
committed
fixes in atl syntax blocks
1 parent 971796b commit 68f17fa

File tree

137 files changed

+332
-258
lines changed

Some content is hidden

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

137 files changed

+332
-258
lines changed

docs/atl/reference/aggregation-and-class-factory-macros.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,8 +233,7 @@ DECLARE_CLASSFACTORY_SINGLETON( obj )
233233
234234
```
235235
template<class T>
236-
class CComClassFactorySingleton :
237-
public CComClassFactory
236+
class CComClassFactorySingleton : public CComClassFactory
238237
```
239238

240239
### Parameters

docs/atl/reference/atl-ole-db-consumer-wizard.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,7 @@ This wizard sets up an OLE DB consumer class with the data bindings necessary to
133133
``` *// Inject table class and table accessor class declarations
134134
[
135135
db_source("<initialization_string>"),
136-
db_table("dbo.Orders")
137-
]
136+
db_table("dbo.Orders")]
138137
... *// Column map
139138
[ db_column(1, status=m_dwOrderIDStatus, length=m_dwOrderIDLength) ] LONG m_OrderID;
140139
[ db_column(2, status=m_dwCustomerIDStatus, length=m_dwCustomerIDLength) ] TCHAR m_CustomerID[6];
@@ -159,8 +158,7 @@ This wizard sets up an OLE DB consumer class with the data bindings necessary to
159158
```
160159
[
161160
db_source("<initialization_string>"),
162-
db_command("SQL_command")
163-
]
161+
db_command("SQL_command")]
164162
... *// Column map using db_column is the same as for consumer type of 'table'
165163
```
166164

docs/atl/reference/ca2aex-class.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ This class is used by the string conversion macros `CA2TEX` and `CT2AEX`, and th
4848
## Syntax
4949

5050
```
51-
template <int t_nBufferLength = 128>
52-
class CA2AEX
51+
template <int t_nBufferLength = 128>
52+
class CA2AEX
5353
```
5454

5555
#### Parameters
@@ -148,14 +148,14 @@ LPSTR m_psz;
148148
The static buffer, used to store the converted string.
149149

150150
```
151-
char m_szBuffer[ t_nBufferLength
152-
];
151+
char m_szBuffer[ t_nBufferLength];
153152
```
154153

155154
## <a name="operator_lpstr"></a> CA2AEX::operator LPSTR
156155
Conversion operator.
157156

158-
```operator LPSTR() const throw();
157+
```
158+
operator LPSTR() const throw();
159159
```
160160

161161
### Return Value

docs/atl/reference/ca2caex-class.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ This class is used by string conversion macros `CA2CTEX` and `CT2CAEX`, and the
4848
## Syntax
4949

5050
```
51-
template<int t_nBufferLength = 128> class CA2CAEX
51+
template<int t_nBufferLength = 128>
52+
class CA2CAEX
5253
```
5354

5455
#### Parameters
@@ -138,7 +139,8 @@ LPCSTR m_psz;
138139
## <a name="operator_lpcstr"></a> CA2CAEX::operator LPCSTR
139140
Conversion operator.
140141

141-
```operator LPCSTR() const throw();
142+
```
143+
operator LPCSTR() const throw();
142144
```
143145

144146
### Return Value

docs/atl/reference/ca2wex-class.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ This class is used by the string conversion macros `CA2TEX`, `CA2CTEX`, `CT2WEX`
4949
## Syntax
5050

5151
```
52-
template <int t_nBufferLength = 128>
53-
class CA2WEX
52+
template <int t_nBufferLength = 128>
53+
class CA2WEX
5454
```
5555

5656
#### Parameters
@@ -153,14 +153,14 @@ LPWSTR m_psz;
153153
The static buffer, used to store the converted string.
154154

155155
```
156-
wchar_t m_szBuffer[ t_nBufferLength
157-
];
156+
wchar_t m_szBuffer[ t_nBufferLength];
158157
```
159158

160159
## <a name="operator_lpwstr"></a> CA2WEX::operator LPWSTR
161160
Conversion operator.
162161

163-
```operator LPWSTR() const throw();
162+
```
163+
operator LPWSTR() const throw();
164164
```
165165

166166
### Return Value

docs/atl/reference/cacl-class.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,8 @@ bool IsNull() const throw();
289289
## <a name="operator_const_acl__star"></a> CAcl::operator const ACL *
290290
Casts a `CAcl` object to an **ACL** (access-control list) structure.
291291

292-
```operator const ACL *() const throw(...);
292+
```
293+
operator const ACL *() const throw(...);
293294
```
294295

295296
### Remarks

docs/atl/reference/cadapt-class.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ This template is used to wrap classes that redefine the address-of operator to r
4848
## Syntax
4949

5050
```
51-
template <class T> class CAdapt
51+
template <class T>
52+
class CAdapt
5253
```
5354

5455
#### Parameters
@@ -121,7 +122,8 @@ T m_T;
121122
## <a name="operator_const_t_amp"></a> CAdapt::operator const T&amp;
122123
Returns a **const** reference to the [m_T](#m_t) member, allowing the adapter object to be treated as if it were an object of type `T`.
123124

124-
```operator const T&() const;
125+
```
126+
operator const T&() const;
125127
```
126128

127129
### Return Value
@@ -130,7 +132,8 @@ T m_T;
130132
## <a name="operator_t_amp"></a> CAdapt::operator T&amp;
131133
Returns a reference to the [m_T](#m_t) member, allowing the adapter object to be treated as if it were an object of type `T`.
132134

133-
```operator T&();
135+
```
136+
operator T&();
134137
```
135138

136139
### Return Value

docs/atl/reference/catlarray-class.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ This class implements an array object.
4242
## Syntax
4343

4444
```
45-
template<typename E, class ETraits = CElementTraits<E>> class CAtlArray
45+
template<typename E, class ETraits = CElementTraits<E>>
46+
class CAtlArray
4647
```
4748

4849
#### Parameters
@@ -285,8 +286,7 @@ typedef ETraits::INARGTYPE INARGTYPE;
285286

286287
```
287288
void InsertArrayAt(size_t iStart,
288-
const CAtlArray<E,
289-
ETraits>* paNew);
289+
const CAtlArray<E, ETraits>* paNew);
290290
```
291291

292292
### Parameters

docs/atl/reference/catlautothreadmodule-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This class implements a thread-pooled, apartment-model COM server.
4545
## Syntax
4646

4747
```
48-
class CAtlAutoThreadModule : public CAtlAutoThreadModuleT<CAtlAutoThreadModule>
48+
class CAtlAutoThreadModule : public CAtlAutoThreadModuleT<CAtlAutoThreadModule>
4949
```
5050

5151
## Remarks

docs/atl/reference/catlautothreadmodulet-class.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ This class provides methods for implementing a thread-pooled, apartment-model CO
4646

4747
```
4848
template <class T, class ThreadAllocator = CComSimpleThreadAllocator,
49-
DWORD dwWait = INFINITE> class ATL_NO_VTABLE CAtlAutoThreadModuleT : public IAtlAutoThreadModule
49+
DWORD dwWait = INFINITE>
50+
class ATL_NO_VTABLE CAtlAutoThreadModuleT : public IAtlAutoThreadModule
5051
```
5152

5253
#### Parameters

docs/atl/reference/catlbasemodule-class.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ This class is instantiated in every ATL project.
4242
## Syntax
4343

4444
```
45-
class CAtlBaseModule :
46-
public _ATL_BASE_MODULE
45+
class CAtlBaseModule : public _ATL_BASE_MODULE
4746
```
4847

4948
## Members

docs/atl/reference/catlcommodule-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This class implements a COM server module.
4242
## Syntax
4343

4444
```
45-
class CAtlComModule : public _ATL_COM_MODULE
45+
class CAtlComModule : public _ATL_COM_MODULE
4646
```
4747

4848
## Members

docs/atl/reference/catldllmodulet-class.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ This class represents the module for a DLL.
4545
## Syntax
4646

4747
```
48-
template <class T> class ATL_NO_VTABLE CAtlDllModuleT : public CAtlModuleT<T>
48+
template <class T>
49+
class ATL_NO_VTABLE CAtlDllModuleT : public CAtlModuleT<T>
4950
```
5051

5152
#### Parameters

docs/atl/reference/catlexception-class.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ CAtlException() throw();
8888
## <a name="operator_hresult"></a> CAtlException::operator HRESULT
8989
Casts the current object to an HRESULT value.
9090

91-
```operator HRESULT() const throw ();
91+
```
92+
operator HRESULT() const throw ();
9293
```
9394

9495
## <a name="m_hr"></a> CAtlException::m_hr

docs/atl/reference/catlexemodulet-class.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ This class represents the module for an application.
4444
## Syntax
4545

4646
```
47-
template <class T> class ATL_NO_VTABLE CAtlExeModuleT : public CAtlModuleT<T>
47+
template <class T>
48+
class ATL_NO_VTABLE CAtlExeModuleT : public CAtlModuleT<T>
4849
```
4950

5051
#### Parameters

docs/atl/reference/catlfile-class.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@ This class provides a thin wrapper around the Windows file-handling API.
4545
## Syntax
4646

4747
```
48-
class CAtlFile :
49-
public CHandle
48+
class CAtlFile : public CHandle
5049
```
5150

5251
## Members
@@ -266,14 +265,17 @@ CAtlTransactionManager* m_pTM;
266265
HRESULT Read(
267266
LPVOID pBuffer,
268267
DWORD nBufSize) throw();
268+
269269
HRESULT Read(
270270
LPVOID pBuffer,
271271
DWORD nBufSize,
272272
DWORD& nBytesRead) throw();
273+
273274
HRESULT Read(
274275
LPVOID pBuffer,
275276
DWORD nBufSize,
276277
LPOVERLAPPED pOverlapped) throw();
278+
277279
HRESULT Read(
278280
LPVOID pBuffer,
279281
DWORD nBufSize,
@@ -373,10 +375,12 @@ HRESULT Write(
373375
DWORD nBufSize,
374376
LPOVERLAPPED pOverlapped,
375377
LPOVERLAPPED_COMPLETION_ROUTINE pfnCompletionRoutine) throw();
378+
376379
HRESULT Write(
377380
LPCVOID pBuffer,
378381
DWORD nBufSize,
379382
DWORD* pnBytesWritten = NULL) throw();
383+
380384
HRESULT Write(
381385
LPCVOID pBuffer,
382386
DWORD nBufSize,

docs/atl/reference/catlfilemapping-class.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,8 @@ This class represents a memory-mapped file, adding a cast operator to the method
4747
## Syntax
4848

4949
```
50-
template <typename T = char>
51-
class CAtlFileMapping :
52-
public CAtlFileMappingBase
50+
template <typename T = char>
51+
class CAtlFileMapping : public CAtlFileMappingBase
5352
```
5453

5554
#### Parameters
@@ -78,7 +77,8 @@ template <typename T = char>
7877
## <a name="operator_t_star"></a> CAtlFileMapping::operator T*
7978
Allows implicit conversion of `CAtlFileMapping` objects to `T`**\***.
8079

81-
```operator T*() const throw();
80+
```
81+
operator T*() const throw();
8282
```
8383

8484
### Return Value

docs/atl/reference/catllist-class.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ This class provides methods for creating and managing a list object.
4242
## Syntax
4343

4444
```
45-
template<typename E, class ETraits = CElementTraits<E>> class CAtlList
45+
template<typename E, class ETraits = CElementTraits<E>>
46+
class CAtlList
4647
```
4748

4849
#### Parameters

docs/atl/reference/catlmap-class.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ This class provides methods for creating and managing a map object.
4343

4444
```
4545
template <typename K,
46-
typename V, class KTraits = CElementTraits<K>, class VTraits = CElementTraits<V>>
47-
class CAtlMap
46+
typename V, class KTraits = CElementTraits<K>, class VTraits = CElementTraits<V>>
47+
class CAtlMap
4848
```
4949

5050
#### Parameters

docs/atl/reference/catlmodule-class.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This class provides methods used by several ATL module classes.
4242
## Syntax
4343

4444
```
45-
class ATL_NO_VTABLE CAtlModule : public _ATL_MODULE
45+
class ATL_NO_VTABLE CAtlModule : public _ATL_MODULE
4646
```
4747

4848
## Members
@@ -230,6 +230,7 @@ virtual LONG Unlock() throw();
230230
HRESULT WINAPI UpdateRegistryFromResourceD(UINT nResID,
231231
BOOL bRegister,
232232
struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();
233+
233234
HRESULT WINAPI UpdateRegistryFromResourceD(LPCTSTR lpszRes,
234235
BOOL bRegister,
235236
struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();
@@ -290,6 +291,7 @@ inline HRESULT WINAPI UpdateRegistryFromResourceDHelper(LPCOLESTR lpszRes,
290291
HRESULT WINAPI UpdateRegistryFromResourceS(UINT nResID,
291292
BOOL bRegister,
292293
struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();
294+
293295
HRESULT WINAPI UpdateRegistryFromResourceS(LPCTSTR lpszRes,
294296
BOOL bRegister,
295297
struct _ATL_REGMAP_ENTRY* pMapEntries = NULL) throw();

docs/atl/reference/catlmodulet-class.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,8 @@ This class implements an ATL module.
4444
## Syntax
4545

4646
```
47-
template <class T>
48-
class ATL_NO_VTABLE CAtlModuleT :
49-
public CAtlModule
47+
template <class T>
48+
class ATL_NO_VTABLE CAtlModuleT : public CAtlModule
5049
```
5150

5251
#### Parameters

docs/atl/reference/catlservicemodulet-class.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ This class implements a service.
4545
## Syntax
4646

4747
```
48-
template <class T, UINT nServiceNameID> class ATL_NO_VTABLE CAtlServiceModuleT : public CAtlExeModuleT<T>
48+
template <class T, UINT nServiceNameID>
49+
class ATL_NO_VTABLE CAtlServiceModuleT : public CAtlExeModuleT<T>
4950
```
5051

5152
#### Parameters

docs/atl/reference/catltemporaryfile-class.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,8 @@ HRESULT LockRange(ULONGLONG nPos, ULONGLONG nCount) throw();
247247
## <a name="operator_handle"></a> CAtlTemporaryFile::operator HANDLE
248248
Returns a handle to the temporary file.
249249

250-
```operator HANDLE() throw();
250+
```
251+
operator HANDLE() throw();
251252
```
252253

253254
## <a name="read"></a> CAtlTemporaryFile::Read

0 commit comments

Comments
 (0)