[go: up one dir, main page]
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

Provide a list of all supported @ annotations #676

Open
akrzemi1 opened this issue Sep 28, 2024 · 2 comments
Open

Provide a list of all supported @ annotations #676

akrzemi1 opened this issue Sep 28, 2024 · 2 comments
Assignees
@fpelliccioni

Comments

@akrzemi1
Copy link
Contributor

I know of at least one @ annotation -- @tparam -- that is not part of "standard" Javadoc annotations.
Please have the documentation provide a comprehensive list.

Also, the docs mention the annotations like @em, but I am missing an example. In HTML there is a starting tag for <em> and an an ending tag </em>. This pair clearly delimits the code that needs to be emphasized. How does this work for `@em? How do I tell it that only the three next words need to be emphasized?
@akrzemi1
Copy link
Contributor Author

For instance, I would like to know, if it has things like @precondition, @postcondition...

@alandefreitas alandefreitas moved this to Accepted in MrDocs Sep 30, 2024
@alandefreitas
Copy link
Collaborator
alandefreitas commented Oct 11, 2024 •
edited
Loading

In the mrdocs documentation, each @ command needs its own page with:

  • the name of the command
  • the syntax of the command
  • a verbal description of what it does
  • an example javadoc and declaration which uses the command
  • the result of rendering the example above

and we need an index page that references all of the above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@fpelliccioni fpelliccioni

Labels
None yet
Projects
MrDocs
Status: Accepted
Milestone
No milestone
Development

No branches or pull requests
3 participants
@fpelliccioni @akrzemi1 @alandefreitas