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

Separate public APIs from private ones and update API documentation generation logic #557

Closed
puzpuzpuz opened this issue Jul 22, 2020 · 0 comments · Fixed by #568
Closed

Comments

@puzpuzpuz
Copy link
Contributor

Currently we don't have a clean separation between public and private APIs of the client. What's even worse, generated documentation includes all private classes, like this one: http://hazelcast.github.io/hazelcast-nodejs-client/api/3.12.3/docs/modules/_util_.html

We should extract interfaces where necessary (as an example, Client should be a TS interface) and make sure that we generate documentation only for such public APIs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants