Skip to content

Do not call markup "Markdown" #507

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

Merged
merged 1 commit into from
Mar 24, 2016
+4 −4
Merged

Do not call markup "Markdown" #507

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions overviews/scaladoc/for-library-authors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ and is related to the code structure within which it is written. It is based on
other comment based documentation systems like Javadoc, but with some extensions
such as:

- Markdown like formatting syntax may be used in the comments.
- Markup may be used in the comments.
- Extended @ tags (e.g. `@tparam`, `@see`, `@note`, `@example`, `@usecase`,
`@since`, etc.)
- Macro definitions (defined values to be substituted in scaladoc).
Expand Down Expand Up @@ -125,12 +125,12 @@ but available from a superclass, those comments will be used.
For explicit comment inheritance, use the `@inheritdoc` tag.


## Markdown style formatting
## Markup

It is still possible to embed HTML tags in Scaladoc (like with Javadoc), but
not necessary most of the time as Markdown styles may be used instead.
not necessary most of the time as markup may be used instead.

Some of the standard Markdown formatting available:
Some of the standard markup available:

`monospace`
''italic text''
Expand Down