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

Documentation improvements #146

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Documentation improvements #146

wants to merge 1 commit into from

Conversation

rustkas
Copy link

@rustkas rustkas commented Apr 25, 2022

  1. Add additional -spec tag to functions in poolboy module.
  2. Improving the readability of the description of the specification (-spec) of function parameters.
  3. Add the use of @equiv tag to increase understanding of how the function works.
  4. Add @doc tags with descriptions of poolboy API.
  5. Add an auxiliary doc_src folder to improve documentation generation.
  6. Add edoc, edoc_private tasks to Makefile.

@rustkas
Documentation improvements
79ed800 
Add -spec tag to all function in poolboy module.
Improving the readability of the description of the specification (-spec) of function parameters.
Add the use of @equiv tag to increase understanding of how the function works.
Add edoc, edoc_private tasks to Makefile.
@rustkas rustkas mentioned this pull request May 6, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@rustkas