Skip to content

docs: fix a few errors on document #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jithinjosepkl merged 2 commits into from
Aug 17, 2022
Merged

docs: fix a few errors on document #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67555c8
docs: fix a few errors on document
May 31, 2022
0246cd0
Merge branch 'master' into docs-fix
jithinjosepkl Aug 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/IND2Adapter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,7 +390,7 @@ HRESULT CreateMemoryWindow(
__Parameters:__
- __iid__ [in]

The IID of the memory region interface requested. IID_IND2MemoryRegion must be supported, but other IIDs may be supported as new interfaces are defined.
The IID of the memory window interface requested. IID_IND2MemoryWindow must be supported, but other IIDs may be supported as new interfaces are defined.

- __ppMemoryWindow__ [out]

Expand Down Expand Up @@ -433,7 +433,7 @@ HRESULT CreateSharedReceiveQueue(
__Parameters:__
- __iid__ [in]

The IID of the memory region interface requested. IID_IND2SharedReceiveQueue must be supported, but other IIDs may be supported as new interfaces are defined.
The IID of the shared receive queue interface requested. IID_IND2SharedReceiveQueue must be supported, but other IIDs may be supported as new interfaces are defined.
- __hOverlappedFile__ [in]

Handle returned by a previous call to [IND2Adapter::CreateOverlappedFile](#ind2adaptercreateoverlappedfile), on which overlapped operations on this shared receive queue should be performed.
Expand Down Expand Up @@ -496,7 +496,7 @@ HRESULT CreateQueuePair(
__Parameters:__
- __iid__ [in]

The IID of the memory region interface requested. IID_IND2QueuePair must be supported, but other IIDs may be supported as new interfaces are defined.
The IID of the queue pair interface requested. IID_IND2QueuePair must be supported, but other IIDs may be supported as new interfaces are defined.
- __pReceiveCompletionQueue__ [in]

An [IND2CompletionQueue](./IND2CompletionQueue.md) interface. The interface is used to queue _Receive_ request results.
Expand Down Expand Up @@ -575,7 +575,7 @@ HRESULT CreateQueuePairWithSrq(
__Parameters:__
- __iid__ [in]

The IID of the memory region interface requested. IID_IND2QueuePair must be supported, but other IIDs may be supported as new interfaces are defined.
The IID of the queue pair interface requested. IID_IND2QueuePair must be supported, but other IIDs may be supported as new interfaces are defined.

- __pReceiveCompletionQueue__ [in]

Expand Down Expand Up @@ -654,7 +654,7 @@ HRESULT CreateConnector(
__Parameters:__
- __iid__ [in]

The IID of the memory region interface requested. IID_IND2Connector must be supported, but other IIDs may be supported as new interfaces are defined.
The IID of the connector interface requested. IID_IND2Connector must be supported, but other IIDs may be supported as new interfaces are defined.

- __hOverlappedFile__ [in]

Expand Down Expand Up @@ -686,7 +686,7 @@ HRESULT CreateListener(
__Parameters:__
- __iid__ [in]

The IID of the memory region interface requested. IID_IND2Listener must be supported, but other IIDs may be supported as new interfaces are defined.
The IID of the listener interface requested. IID_IND2Listener must be supported, but other IIDs may be supported as new interfaces are defined.

- __hOverlappedFile__ [in]

Expand Down
2 changes: 1 addition & 1 deletion docs/IND2Connector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ The remote peer or connecting peer can call this method to reject the connection
## IND2Connector::GetReadLimits
Retrieves the read limits of the peer.
```
HRESULT GetPrivateData(
HRESULT GetReadLimits(
[out, optional] ULONG *pInboundReadLimit,
[out, optional] ULONG *pOutboundReadLimit,
);
Expand Down