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

[RFC]: Parse documentation #5

Open
zarubaf opened this issue Mar 12, 2020 · 1 comment
Open

[RFC]: Parse documentation #5

zarubaf opened this issue Mar 12, 2020 · 1 comment

Comments

@zarubaf
Copy link
Collaborator

zarubaf commented Mar 12, 2020

Ideally, when able to also process comments, we can automatically parse documentation. Let's start by gathering some ideas here:

  • Document module hierarchy
  • Markdown comments at top of file, similar to Rust /// and //!.
  • Port descriptions
@zarubaf
Copy link
Collaborator Author

zarubaf commented Mar 22, 2020

  • Function documentation
  • Enum documentation
  • Deprecated annotation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant