Currently the auto documentation from code to asciidoc files does collect information by following
annotations:
@MustbeDocumented (SecHub only)
@PDSMustbeDocumented (PDS only)
This makes it also not usable in projects outside PDS and SecHub which means there must be documented manually.
Wanted
Only one annotation for all
Shall work not only in PDS and SecHub but also in Wrapper applications etc.
Solution
[ ] Move @MustBeDocumented to sechub-commons-core
[ ] Introduce group field to differ between sechub, pds and others (just a string, we can use constants...). We can use the group name for generation target path resolving. Default group will be sechub
[ ] Delete @PDSMustBeDocumented and replace all with @MustBeDocumented + group pds
[ ] Change generators were @PDSMustBeDocumented is used and filter for pds group
Situation
Currently the auto documentation from code to asciidoc files does collect information by following annotations:
@MustbeDocumented(SecHub only)@PDSMustbeDocumented(PDS only)This makes it also not usable in projects outside PDS and SecHub which means there must be documented manually.
Wanted
Solution
@MustBeDocumentedtosechub-commons-coregroupfield to differ betweensechub,pdsand others (just a string, we can use constants...). We can use the group name for generation target path resolving. Default group will besechub@PDSMustBeDocumentedand replace all with@MustBeDocumented+ grouppds@PDSMustBeDocumentedis used and filter for pds group