Documenting Related Components
Often Processors and ControllerServices are related to one another. Sometimes it is a
put/get relation as in PutFile
and GetFile
.
Sometimes a Processor uses a ControllerService like InvokeHTTP
and
StandardSSLContextService
. Sometimes one ControllerService uses
another like DistributedMapCacheClientService
and
DistributedMapCacheServer
. Developers of these extension points may
relate these different components using the SeeAlso
tag. This
annotation links these components in the documentation. SeeAlso
can be
applied to Processors, ControllerServices and ReportingTasks. An example of how to do this
is listed below:
@SeeAlso(GetFile.class) public class PutFile extends AbstractProcessor {