Skip to content
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.

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

docs: change WebSocket.frame* event type to WebSocketFrame in java #5384

Merged
merged 1 commit into from
Feb 9, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/src/api/class-websocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,20 @@ Fired when the websocket closes.

Fired when the websocket recieves a frame.

## event: WebSocket.frameReceived
* langs: csharp, java
- type: <[WebSocketFrame]>

## event: WebSocket.frameSent
- type: <[Object]>
- `payload` <[string]|[Buffer]> frame payload

Fired when the websocket sends a frame.

## event: WebSocket.frameSent
* langs: csharp, java
- type: <[WebSocketFrame]>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where is WebSocketFrame defined?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in class-websocketframe.md


## event: WebSocket.socketError
- type: <[String]>

Expand Down
2 changes: 1 addition & 1 deletion utils/doclint/api_parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ class ApiParser {
member.async = true;
}
const clazz = this.classes.get(match[2]);
const existingMember = clazz.membersArray.find(m => m.name === name && m.kind === "method");
const existingMember = clazz.membersArray.find(m => m.name === name && m.kind === member.kind);
if (existingMember) {
for (const lang of member.langs.only) {
existingMember.langs.types = existingMember.langs.types || {};
Expand Down