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.

Sign up for GitHub

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

Jump to bottom

Add in-comment documentation #3

Open
Abathargh opened this issue Dec 7, 2021 · 0 comments
Open

Add in-comment documentation #3

Abathargh opened this issue Dec 7, 2021 · 0 comments
Assignees
@Abathargh
Labels
documentation Improvements or additions to documentation
Milestone
General

Comments

@Abathargh
Copy link
Member

Every module is missing in-comment function and module scoped documentation, add it in order to generate doc pages that can be used for easier future development and usage.
@Abathargh Abathargh added the documentation Improvements or additions to documentation label Dec 7, 2021
@Abathargh Abathargh added this to the General milestone Dec 7, 2021
@Abathargh Abathargh self-assigned this Dec 7, 2021
Abathargh added a commit that referenced this issue Dec 9, 2021
@Abathargh
#3 changed: README build/install stub.
f4511c9
Abathargh added a commit that referenced this issue Dec 11, 2021
@Abathargh
#3 - changed: added in-comment documentation to the map and set conta…
764db54 
…iners in the mqtt sub-package
Abathargh added a commit that referenced this issue Dec 12, 2021
@Abathargh
#3 changed: added go install string to the README
bbd6625
Abathargh added a commit that referenced this issue Dec 12, 2021
@Abathargh
#3 changed: added the first part of the documentation related to the …
bfe45e0 
…MQTT data table
Abathargh added a commit that referenced this issue Dec 20, 2021
@Abathargh
#3 - changed: fixed typo in concurrent_map comments
d1ee4c0
Abathargh added a commit that referenced this issue Dec 20, 2021
@Abathargh
#3 - changed: added in-comment documentation for the plugin service m…
180e6c4 
…odule.
Abathargh added a commit that referenced this issue Dec 23, 2021
@Abathargh
#3 - changed: added in-comment documentation for the plugin service m…
47c1168 
…odule missing methods/typos.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Abathargh Abathargh

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
General
Development

No branches or pull requests
1 participant
@Abathargh