Community
Participate
Working Groups
There are some enums used in Tycho that don't seem to be documented. For example baselineMode and baselineReplace[1]. The enums do have reasonable javadoc, but they don't seem to be generating anything at the moment. [1] https://www.eclipse.org/tycho/sitedocs/tycho-p2/tycho-p2-plugin/p2-metadata-default-mojo.html#baselineReplace
I am trying to figure out if/how this can be resolved by generating HTML from the enums. If not I will just list the options in the javadoc for where they are mentioned.
Seeing as other plugins (key ones like clean and compile) don't provide links/etc to complex types, I am not going to try too hard to auto-generate docs from enums. References: clean's filesets parameter does not document or even link automatically to complex type Fileset: https://maven.apache.org/plugins/maven-clean-plugin/clean-mojo.html#filesets compile - which was written before enums existed - uses String type for something that is essentially an enum and the possible values are listed with String parameter. See compilerReuseStrategy as an example https://maven.apache.org/plugins/maven-compiler-plugin/compile-mojo.html#compilerReuseStrategy So I will just add to the options in the parameter's javadoc. This will at least save the next person from having to get the source code to find out what the legal values are.
I am using https://github.com/apache/maven-compiler-plugin/blob/24141bda1eff894367585f90aaf573461ac22370/src/main/java/org/apache/maven/plugin/compiler/AbstractCompilerMojo.java#L450 as an example of how to format the choices for the enums.
New Gerrit change created: https://git.eclipse.org/r/145060
Thanks Jonah!
Gerrit change https://git.eclipse.org/r/145060 was merged to [master]. Commit: http://git.eclipse.org/c/tycho/org.eclipse.tycho.git/commit/?id=7cae7fb332dd6b294fecf876ca6e27a763dd3591
