inloco / incognia-go

Go library for Incognia API
MIT License
5 stars 5 forks source link

Add comments to public structs, methods, functions, and packages #27

Open t0rr3sp3dr0 opened 2 years ago

t0rr3sp3dr0 commented 2 years ago

Currently, the library has no godoc-compatible comments. The generated documentation contains nothing but the struct definitions and signature for public functions: https://pkg.go.dev/repo.incognia.com/go/incognia.

Add comments to the code so we can have a good documentation of the library.

t0rr3sp3dr0 commented 2 years ago

Reference: https://github.com/golang/go/wiki/CodeReviewComments#doc-comments