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

Missing documentation #33

Closed
warpdesign opened this issue Dec 28, 2017 · 2 comments
Closed

Missing documentation #33

warpdesign opened this issue Dec 28, 2017 · 2 comments
Labels
docma-web documentation v2 ✓ Fixed or implemented. To be released.

Comments

@warpdesign
Copy link
Contributor

I found that the following methods were not documented:

  • docma.utils.listType
  • docma.utils.listTypeDesc

Since there are used in the default template's filters ($returns, $extends, $exceptions) I think it would be a good idea to add them.
@onury
Copy link
Owner

onury commented Dec 28, 2017 •
edited
Loading

Those are left out on purpose. I'll check if they're ok for general use and add.

@onury
Copy link
Owner

onury commented Dec 29, 2017

These are now included but for semantics, they are refactored in v2 as below:

  • docma.utils.listType() refactored to docma.utils.getCodeTags()
  • docma.utils.listTypeDesc refactored to docma.utils.getFormattedTypeList()

Each now has additional arguments for format options.

@onury onury added v2 ✓ Fixed or implemented. To be released. labels Dec 29, 2017
@onury onury closed this as completed in f54e4ac Apr 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docma-web documentation v2 ✓ Fixed or implemented. To be released.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@warpdesign @onury