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

MenoData/DocTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DocTags

Additional JavaDoc-Tags

Goals:

This small library mainly serves for improvements of the JavaDoc of Time4J but might also be useful for any other java project. Four extra tags are offered:

  • doctags.concurrency (documents the concurrency behaviour of a class)
  • 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:

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

will be displayed like

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