Skip to content
This repository was archived by the owner on Sep 28, 2022. It is now read-only.

SDK V3 Kuzzle&WebSocket Documentation#42

Merged
jenow merged 22 commits into
KZL-1346/sdk-v3-websocket-unit-testsfrom
KZL-1346/sdk-v3-websocket-documentation
Jan 7, 2020
Merged

SDK V3 Kuzzle&WebSocket Documentation#42
jenow merged 22 commits into
KZL-1346/sdk-v3-websocket-unit-testsfrom
KZL-1346/sdk-v3-websocket-documentation

Conversation

@Shiranuit
Copy link
Copy Markdown
Contributor

@Shiranuit Shiranuit commented Sep 3, 2019

⚠️ Depends on [#41]

What does this PR do ?

Add documentation for Kuzzle & WebSocket class

@codecov
Copy link
Copy Markdown

codecov Bot commented Sep 3, 2019

Codecov Report

❗ No coverage uploaded for pull request base (KZL-1346/sdk-v3-websocket-unit-tests@1f2f9dc). Click here to learn what that means.
The diff coverage is 66.66%.

Impacted file tree graph

@@                           Coverage Diff                           @@
##             KZL-1346/sdk-v3-websocket-unit-tests      #42   +/-   ##
=======================================================================
  Coverage                                        ?   70.87%           
  Complexity                                      ?       76           
=======================================================================
  Files                                           ?       19           
  Lines                                           ?      333           
  Branches                                        ?       29           
=======================================================================
  Hits                                            ?      236           
  Misses                                          ?       77           
  Partials                                        ?       20
Impacted Files Coverage Δ Complexity Δ
...java/io/kuzzle/sdk/Protocol/AbstractWebSocket.java 61.11% <ø> (ø) 11 <0> (?)
...uzzle/sdk/CoreClasses/Responses/ErrorResponse.java 100% <ø> (ø) 3 <0> (?)
.../io/kuzzle/sdk/CoreClasses/Responses/Response.java 100% <100%> (ø) 4 <1> (?)
.../kuzzle/sdk/CoreClasses/Json/JsonSerializable.java 50% <50%> (ø) 1 <1> (?)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1f2f9dc...be9ab65. Read the comment docs.

@Shiranuit Shiranuit added the wip label Sep 13, 2019
@Shiranuit Shiranuit removed the wip label Sep 16, 2019
Comment thread kuzzle-sdk-java/doc/3/core-classes/kuzzle/constructor/index.md Outdated
Comment thread kuzzle-sdk-java/doc/3/core-classes/kuzzle/connect/index.md Outdated
Comment thread kuzzle-sdk-java/doc/3/core-classes/kuzzle/connect/index.md Outdated
Comment thread kuzzle-sdk-java/doc/3/core-classes/kuzzle/constructor/index.md Outdated
Comment thread kuzzle-sdk-java/doc/3/exceptions/kuzzle-exception/index.md Outdated
Comment thread kuzzle-sdk-java/doc/3/protocols/websocket/constructor/index.md
Comment thread kuzzle-sdk-java/.ci/doc/docker-compose.yml Outdated
Comment thread kuzzle-sdk-java/.ci/doc/docker-compose.yml Outdated
Comment thread kuzzle-sdk-java/.ci/doc/docker-compose.yml Outdated
Comment thread kuzzle-sdk-java/.ci/doc/docker-compose.yml Outdated
Comment thread kuzzle-sdk-java/.ci/doc/docker-compose.yml Outdated
Comment thread kuzzle-sdk-java/.ci/docker-compose.yml Outdated
Comment thread kuzzle-sdk-java/.ci/docker-compose.yml Outdated
Comment thread kuzzle-sdk-java/.ci/docker-compose.yml Outdated
Comment thread kuzzle-sdk-java/.ci/docker-compose.yml Outdated
Comment thread kuzzle-sdk-java/.ci/docker-compose.yml Outdated
Shiranuit and others added 3 commits November 25, 2019 14:44
Co-Authored-By: Adrien Maret <amaret93@gmail.com>
Co-Authored-By: Sébastien Cottinet <scottinet@protonmail.com>
Co-Authored-By: Luca Marchesini <xbill82@gmail.com>
Copy link
Copy Markdown
Contributor

@Aschen Aschen left a comment

Choose a reason for hiding this comment

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

Can you start the page essentials/events also please ?
Since you already have 2 events (tokenExpired and unhandledResponseEvent), you should document them on the dedicated page.

@jenow jenow merged commit c213d7e into KZL-1346/sdk-v3-websocket-unit-tests Jan 7, 2020
@jenow jenow deleted the KZL-1346/sdk-v3-websocket-documentation branch January 7, 2020 09:36
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants