Skip to content

Commit

Permalink
Merge pull request #471 from janekdb/master
Browse files Browse the repository at this point in the history
Fix markdown example for italic and bold
  • Loading branch information
heathermiller committed Dec 6, 2015
2 parents 0741722 + 6896b70 commit 6d7efb5
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions overviews/scaladoc/for-library-authors.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ that starts with a `/**` and ends with a `*/`, like this:
* left margin is on the same column on the
* first line and on subsequent ones.
*
* The closing scaladoc tag goes on its own,
* The closing Scaladoc tag goes on its own,
* separate line. E.g.
*
* Calculate the square of the given number
Expand Down Expand Up @@ -71,7 +71,7 @@ include:
- `@return` detail the return value from a method (one per method).


### Constructor and/or Class tags
### Method, Constructor and/or Class tags
- `@throws` what exceptions (if any) the method or constructor may throw.
- `@param` detail a value parameter for a method or constructor, provide one
per parameter to the method/constructor.
Expand Down Expand Up @@ -118,7 +118,7 @@ If a comment is not provided for an entity at the current inheritance level, but
is supplied for the overridden entity at a higher level in the inheritance
hierarchy, the comment from the super-class will be used.

Likewise if `@param`, `@tparam`, `@return` and other entity tags are ommitted
Likewise if `@param`, `@tparam`, `@return` and other entity tags are omitted
but available from a superclass, those comments will be used.

### Explicit
Expand All @@ -133,8 +133,8 @@ not necessary most of the time as Markdown styles may be used instead.
Some of the standard Markdown formatting available:

`monospace`
``italic text``
```bold text```
''italic text''
'''bold text'''
__underline__
^superscript^
,,subscript,,
Expand Down
2 changes: 1 addition & 1 deletion overviews/scaladoc/interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ may not have known about already, here are a few key points.
- By expanding linear supertypes triangle, you can see the linearized trait
definitions for the current class, trait or object.
- Known subclasses lists all subclasses for this entity within the current
scaladoc.
Scaladoc.
- Type hierarchy shows a graphical view of this class related to its super
classes and traits, immediate sub-types, and important related entities. The
graphics themselves are links to the various entities.
Expand Down

0 comments on commit 6d7efb5

Please sign in to comment.