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

Can notes be added? #449

Open
Ma-XX-oN opened this issue May 22, 2020 · 0 comments
Open

Can notes be added? #449

Ma-XX-oN opened this issue May 22, 2020 · 0 comments

Comments

@Ma-XX-oN
Copy link

Ma-XX-oN commented May 22, 2020

Would be nice to have some form of note/warning/important tagging. E.g.

@note When you do this, that could result in that.
@warning Doing this could format your hard drive and cause demons from exiting your nostrils.
@Important Do not look into the sun too long or you will go blind!

This would, for example, allow the markup to translate this to something like putting a vertical line to the left and add a hanging indent. Somehow emphasize the paragraphs that follow the tag.

Would also be good to be able to control if the note should remain indented (to be part of the @param/@return) or not to show that it is a note for the entire @method.

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