Skip to content
This repository has been archived by the owner on Dec 16, 2021. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MenoData committed May 20, 2015
1 parent f9f0ffa commit a0565fd
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,15 @@ This small library mainly serves for improvements of the JavaDoc of Time4J but m
- **doctags.experimental** (documents the experimental status of a class)
- **doctags.spec** (documents a specification requirement)
- **doctags.exclude** (excludes a program element from public API and JavaDoc)

Usage:
------

```java
/** @doctags.concurrency {immutable} */
```

will be displayed like

**Concurrency:** This class is immutable and can be used by multiple threads in parallel.

0 comments on commit a0565fd

Please sign in to comment.