Skip to content

Commit 2df4e5e

Browse files
authored
Merge pull request #1189 from msebolt/windows-formatting-review-pr11
windows formatting review pr11
2 parents 9832ae2 + 9ce1f80 commit 2df4e5e

30 files changed

+432
-454
lines changed

docs/windows/implements-structure.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ms.author: "mblome"
1313
ms.workload: ["cplusplus", "uwp"]
1414
---
1515
# Implements Structure
16-
Implements QueryInterface and GetIid for the specified interfaces.
16+
Implements `QueryInterface` and `GetIid` for the specified interfaces.
1717

1818
## Syntax
1919

@@ -46,44 +46,44 @@ template <
4646
struct __declspec(novtable) Implements<RuntimeClassFlags<flags>, I0, I1, I2, I3, I4, I5, I6, I7, I8> : Details::ImplementsHelper<RuntimeClassFlags<flags>, typename Details::InterfaceListHelper<I0, I1, I2, I3, I4, I5, I6, I7, I8>::TypeT>, Details::ImplementsBase;
4747
```
4848

49-
#### Parameters
50-
`I0`
49+
### Parameters
50+
*I0*
5151
The zeroth interface ID. (Mandatory)
5252

53-
`I1`
53+
*I1*
5454
The first interface ID. (Optional)
5555

56-
`I2`
56+
*I2*
5757
The second interface ID. (Optional)
5858

59-
`I3`
59+
*I3*
6060
The third interface ID. (Optional)
6161

62-
`I4`
62+
*I4*
6363
The fourth interface ID. (Optional)
6464

65-
`I5`
65+
*I5*
6666
The fifth interface ID. (Optional)
6767

68-
`I6`
68+
*I6*
6969
The sixth interface ID. (Optional)
7070

71-
`I7`
71+
*I7*
7272
The seventh interface ID. (Optional)
7373

74-
`I8`
74+
*I8*
7575
The eigth interface ID. (Optional)
7676

77-
`I9`
77+
*I9*
7878
The ninth interface ID. (Optional)
7979

80-
`flags`
80+
*flags*
8181
Configuration flags for the class. One or more [RuntimeClassType](../windows/runtimeclasstype-enumeration.md) enumerations that are specified in a [RuntimeClassFlags](../windows/runtimeclassflags-structure.md) structure.
8282

8383
## Remarks
84-
Derives from the list of specified interfaces and implements helper templates for QueryInterface and GetIid.
84+
Derives from the list of specified interfaces and implements helper templates for `QueryInterface` and `GetIid`.
8585

86-
Each `I0` through `I9` interface parameter must derive from either IUnknown, IInspectable, or the [ChainInterfaces](../windows/chaininterfaces-structure.md) template. The `flags` parameter determines whether support is generated for IUnknown or IInspectable.
86+
Each *I0* through *I9* interface parameter must derive from either `IUnknown`, `IInspectable`, or the [ChainInterfaces](../windows/chaininterfaces-structure.md) template. The *flags* parameter determines whether support is generated for `IUnknown` or `IInspectable`.
8787

8888
## Members
8989

@@ -98,7 +98,7 @@ struct __declspec(novtable) Implements<RuntimeClassFlags<flags>, I0, I1, I2, I3,
9898
|Name|Description|
9999
|----------|-----------------|
100100
|[Implements::CanCastTo Method](../windows/implements-cancastto-method.md)|Gets a pointer to the specified interface.|
101-
|[Implements::CastToUnknown Method](../windows/implements-casttounknown-method.md)|Gets a pointer to the underlying IUnknown interface.|
101+
|[Implements::CastToUnknown Method](../windows/implements-casttounknown-method.md)|Gets a pointer to the underlying `IUnknown` interface.|
102102
|[Implements::FillArrayWithIid Method](../windows/implements-fillarraywithiid-method.md)|Inserts the interface ID specified by the current zeroth template parameter into the specified array element.|
103103

104104
### Protected Constants

docs/windows/implementsbase-structure.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ struct ImplementsBase;
2424
## Remarks
2525
Used to validate template parameter types in [Implements Structure](../windows/implements-structure.md).
2626

27-
The ImplementsBase structure is empty by design.
27+
The **ImplementsBase** structure is empty by design.
2828

2929
## Inheritance Hierarchy
3030
`ImplementsBase`

docs/windows/implementshelper-cancastto-method.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Supports the WRL infrastructure and is not intended to be used directly from you
1818
## Syntax
1919

2020
```
21-
2221
HRESULT CanCastTo(
2322
REFIID riid,
2423
_Deref_out_ void **ppv
@@ -30,14 +29,14 @@ HRESULT CanCastTo(
3029
);
3130
```
3231

33-
#### Parameters
34-
`riid`
32+
### Parameters
33+
*riid*
3534
Reference to an interface ID.
3635

37-
`ppv`
38-
If this operation is successful, a pointer to the interface specified by `riid` or `iid`.
36+
*ppv*
37+
If this operation is successful, a pointer to the interface specified by *riid* or *iid*.
3938

40-
`iid`
39+
*iid*
4140
Reference to an interface ID.
4241

4342
## Return Value

docs/windows/implementshelper-casttounknown-method.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ IUnknown* CastToUnknown();
2525
Pointer to the underlying IUnknown interface.
2626

2727
## Remarks
28-
Gets a pointer to the underlying IUnknown interface for the current Implements structure.
28+
Gets a pointer to the underlying `IUnknown` interface for the current `Implements` structure.
2929

3030
## Requirements
3131
**Header:** implements.h

docs/windows/implementshelper-fillarraywithiid-method.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ void FillArrayWithIid(
2424
```
2525

2626
#### Parameters
27-
`index`
28-
A zero-based index that indicates the starting array element for this operation. When this operation completes, `index` is incremented by 1.
27+
*index*
28+
A zero-based index that indicates the starting array element for this operation. When this operation completes, *index* is incremented by 1.
2929

30-
`iids`
30+
*iids*
3131
An array of type IIDs.
3232

3333
## Remarks

docs/windows/implementshelper-iidcount-constant.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,11 @@ Supports the WRL infrastructure and is not intended to be used directly from you
1818
## Syntax
1919

2020
```
21-
2221
static const unsigned long IidCount;
2322
```
2423

2524
## Remarks
26-
Holds the number of implemented interface IDs in the current Implements object.
25+
Holds the number of implemented interface IDs in the current `Implements` object.
2726

2827
## Requirements
2928
**Header:** implements.h

docs/windows/implementshelper-structure.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ template <
2626
friend struct Details::ImplementsHelper;
2727
```
2828

29-
#### Parameters
30-
`RuntimeClassFlagsT`
29+
### Parameters
30+
*RuntimeClassFlagsT*
3131
A field of flags that specifies one or more [RuntimeClassType](../windows/runtimeclasstype-enumeration.md) enumerators.
3232

33-
`ILst`
33+
*ILst*
3434
A list of interface IDs.
3535

36-
`IsDelegateToClass`
37-
Specify `true` if the current instance of Implements is a base class of the first interface ID in `ILst`; otherwise, `false`.
36+
*IsDelegateToClass*
37+
Specify **true** if the current instance of `Implements` is a base class of the first interface ID in *ILst*; otherwise, **false**.
3838

3939
## Remarks
4040
Helps implement the [Implements](../windows/implements-structure.md) structure.
@@ -52,5 +52,5 @@ friend struct Details::ImplementsHelper;
5252
**Namespace:** Microsoft::WRL::Details
5353

5454
## See Also
55-
[Reference (Windows Runtime Library)](http://msdn.microsoft.com/en-us/00000000-0000-0000-0000-000000000000)
55+
[Reference (Windows Runtime Library)](http://msdn.microsoft.com/00000000-0000-0000-0000-000000000000)
5656
[Microsoft::WRL::Details Namespace](../windows/microsoft-wrl-details-namespace.md)

docs/windows/import.md

+77-78
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,77 @@
1-
---
2-
title: "import | Microsoft Docs"
3-
ms.custom: ""
4-
ms.date: "11/04/2016"
5-
ms.technology: ["cpp-windows"]
6-
ms.topic: "reference"
7-
f1_keywords: ["vc-attr.import"]
8-
dev_langs: ["C++"]
9-
helpviewer_keywords: ["import attribute"]
10-
ms.assetid: ebf07cae-39fb-4047-8b57-54af0a9a83de
11-
author: "mikeblome"
12-
ms.author: "mblome"
13-
ms.workload: ["cplusplus", "uwp"]
14-
---
15-
# import
16-
Specifies another .idl, .odl, or header file containing definitions you want to reference from your main IDL.
17-
18-
## Syntax
19-
20-
```
21-
22-
[ import(
23-
idl_file
24-
) ];
25-
```
26-
27-
#### Parameters
28-
`idl_file`
29-
The name of an .idl file that you want imported into the type library of the current project.
30-
31-
## Remarks
32-
The **import** C++ attribute causes an `#import` statement to be placed below the `import "docobj.idl"` statement in the generated .idl file. The **import** attribute has the same functionality as the [import](http://msdn.microsoft.com/library/windows/desktop/aa367047) MIDL attribute.
33-
34-
The **import** attribute only places the specified file into the .idl file that will be generated by your project; the **import** attribute does not let you call constructs in the specified file from source code in your project. To call constructs in the specified file from source code in your project, either use [#import](../preprocessor/hash-import-directive-cpp.md) and the `embedded_idl` attribute or you can include the .h file for the `idl_file`, if a .h file exists.
35-
36-
## Example
37-
The following code:
38-
39-
```
40-
// cpp_attr_ref_import.cpp
41-
// compile with: /LD
42-
[module(name="MyLib")];
43-
[import(import.idl)];
44-
```
45-
46-
produces the following code in the generated .idl file:
47-
48-
```
49-
import "docobj.idl";
50-
import "import.idl";
51-
52-
[ uuid(EED3644C-8488-3ECD-BA97-147DB3CDB499), version(1.0) ]
53-
library MyLib {
54-
importlib("stdole2.tlb");
55-
importlib("olepro32.dll");
56-
...
57-
```
58-
59-
## Requirements
60-
61-
### Attribute Context
62-
63-
|||
64-
|-|-|
65-
|**Applies to**|Anywhere|
66-
|**Repeatable**|No|
67-
|**Required attributes**|None|
68-
|**Invalid attributes**|None|
69-
70-
For more information, see [Attribute Contexts](../windows/attribute-contexts.md).
71-
72-
## See Also
73-
[IDL Attributes](../windows/idl-attributes.md)
74-
[Stand-Alone Attributes](../windows/stand-alone-attributes.md)
75-
[importidl](../windows/importidl.md)
76-
[importlib](../windows/importlib.md)
77-
[include](../windows/include-cpp.md)
78-
[includelib](../windows/includelib-cpp.md)
1+
---
2+
title: "import | Microsoft Docs"
3+
ms.custom: ""
4+
ms.date: "11/04/2016"
5+
ms.technology: ["cpp-windows"]
6+
ms.topic: "reference"
7+
f1_keywords: ["vc-attr.import"]
8+
dev_langs: ["C++"]
9+
helpviewer_keywords: ["import attribute"]
10+
ms.assetid: ebf07cae-39fb-4047-8b57-54af0a9a83de
11+
author: "mikeblome"
12+
ms.author: "mblome"
13+
ms.workload: ["cplusplus", "uwp"]
14+
---
15+
# import
16+
Specifies another .idl, .odl, or header file containing definitions you want to reference from your main IDL.
17+
18+
## Syntax
19+
20+
```
21+
[ import(
22+
idl_file
23+
) ];
24+
```
25+
26+
### Parameters
27+
*idl_file*
28+
The name of an .idl file that you want imported into the type library of the current project.
29+
30+
## Remarks
31+
The **import** C++ attribute causes an `#import` statement to be placed below the `import "docobj.idl"` statement in the generated .idl file. The **import** attribute has the same functionality as the [import](http://msdn.microsoft.com/library/windows/desktop/aa367047) MIDL attribute.
32+
33+
The **import** attribute only places the specified file into the .idl file that will be generated by your project; the **import** attribute does not let you call constructs in the specified file from source code in your project. To call constructs in the specified file from source code in your project, either use [#import](../preprocessor/hash-import-directive-cpp.md) and the `embedded_idl` attribute or you can include the .h file for the *idl_file*, if a .h file exists.
34+
35+
## Example
36+
The following code:
37+
38+
```cpp
39+
// cpp_attr_ref_import.cpp
40+
// compile with: /LD
41+
[module(name="MyLib")];
42+
[import(import.idl)];
43+
```
44+
45+
produces the following code in the generated .idl file:
46+
47+
```
48+
import "docobj.idl";
49+
import "import.idl";
50+
51+
[ uuid(EED3644C-8488-3ECD-BA97-147DB3CDB499), version(1.0) ]
52+
library MyLib {
53+
importlib("stdole2.tlb");
54+
importlib("olepro32.dll");
55+
...
56+
```
57+
58+
## Requirements
59+
60+
### Attribute Context
61+
62+
|||
63+
|-|-|
64+
|**Applies to**|Anywhere|
65+
|**Repeatable**|No|
66+
|**Required attributes**|None|
67+
|**Invalid attributes**|None|
68+
69+
For more information, see [Attribute Contexts](../windows/attribute-contexts.md).
70+
71+
## See Also
72+
[IDL Attributes](../windows/idl-attributes.md)
73+
[Stand-Alone Attributes](../windows/stand-alone-attributes.md)
74+
[importidl](../windows/importidl.md)
75+
[importlib](../windows/importlib.md)
76+
[include](../windows/include-cpp.md)
77+
[includelib](../windows/includelib-cpp.md)

0 commit comments

Comments
 (0)