Skip to content

Lack of API-docs makes it very hard to onboard users  #158

Open
@holgerbrandl

Description

@holgerbrandl

It seems to be by design to split documentation and implementation. However, when working with the library a java-doc would be very helpful. Maybe by providing pointers into HTML documentation, but maybe also a more classical API documentation to guide development. Currently, because the library is rather complex and has grown considerably, it is a hard learning experience.

This would also allow documenting the numerous parameters that are not reflected in the guide, such as moveToTop in groupBy to give one example. Parameter documentation IMHO works best in place via javadoc, because it's the closest to the actual use/call-site.

Example to demonstrate the problem:
image

Metadata

Metadata

Assignees

Labels

KDocsImprovements or additions to KDocs

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions