Module imagingbook.core
Package imagingbook.core.jdoc

Annotation Type JavaDocBaseUrl

@Retention(RUNTIME) @Target(PACKAGE) public @interface JavaDocBaseUrl

This package-level annotation is used to specify a URL for automatic retrieval of JavaDoc information. The the supplied URL-string must include all address parts including the module part and must end with '/'.

For example, for class 'Compute_Histogram' in package 'Ch02_Histograms_Statistics' and module 'imagingbook_plugins_book' the associated JavaDoc page is 

 https://imagingbook.github.io/imagingbook-public/javadoc/imagingbook_plugins_book/Ch02_Histograms_Statistics/Compute_Histogram.html
i.e., in the format 
     https://BASEURL/MODULENAME/PACKAGENAME/CLASSNAME.htlm
In this case, the URL-string to be supplied is 
     https://BASEURL/MODULENAME/
that is, 
     https://imagingbook.github.io/imagingbook-public/javadoc/imagingbook_plugins_book/

The remaining parts (PACKAGENAME, CLASSNAME) are filled in automatically.

This information is used by JavaDocHelp.getJavaDocUrl(Class). Future version may include annotations at the MODULE and TYPE (class) level. Note that currently ImageJ does not fully support modules and cannot read the names and annotations of external modules.

See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value