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.

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

Warning on undocumented items #1817

Closed
Nokel81 opened this issue Dec 6, 2021 · 0 comments · Fixed by #1819
Closed

Warning on undocumented items #1817

Nokel81 opened this issue Dec 6, 2021 · 0 comments · Fixed by #1819
Labels
enhancement Improved functionality

Comments

@Nokel81
Copy link
Contributor

Nokel81 commented Dec 6, 2021

Search Terms

  • require
  • docs
  • warning

Problem

It would be nice to require the inclusion of documentation when a new type is introduced.

Suggested Solution

Output a warning if an item do not have any documentation associated with it. This could be configured for functions, interfaces, types, methods, classes, and variables.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improved functionality
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add option to warn on undocumented items Nokel81/typedoc
1 participant
@Nokel81