de.smartics.projectdoc.annotations
Annotation Type DocCategory

@Documented
@Target(value={TYPE,FIELD,METHOD})
@Retention(value=RUNTIME)
public @interface DocCategory

Specifies the categories a document is associated with. A document may be added to none or any number of categories.

Categories are organized hierarchically. This organization is not reflected in the annotation. The annotations simply identify the categories by their name.

Annotations found at the type level are inherited to the elements defined in this type.

This is a filing element.

 
   
   

    
    
Usage Example
    
    
@DocCategory("parent-category")
  public interface TestProperties
  {
    String inheritAll();

    @DocCategory({ "sample-category one" })
    String oneValue();

    @DocCategory({ "sample-category one", "sample-category two", "sample-category three" })
    String multipleValues();
  }
  
   
   
 

See Also:

Document, DocParent, DocTag

Required Element Summary

String[]

value The names of the categories the annotated element belongs to.

Element Detail

value

public abstract String[] value

The names of the categories the annotated element belongs to.