Bug 548726

Summary:	p2-metadata's documentation of baselineMode and baselineReplace incomplete
Product:	z_Archived	Reporter:	Jonah Graham <jonah>
Component:	Tycho	Assignee:	Jonah Graham <jonah>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	jonah, mistria
Version:	unspecified	Keywords:	Documentation
Target Milestone:	---
Hardware:	All
OS:	All
See Also:	https://git.eclipse.org/r/145060 https://git.eclipse.org/c/tycho/org.eclipse.tycho.git/commit/?id=7cae7fb332dd6b294fecf876ca6e27a763dd3591
Whiteboard:

Description Jonah Graham

2019-06-27 13:51:42 EDT

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

Comment 1 Jonah Graham

2019-06-27 13:54:16 EDT

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.

Comment 2 Jonah Graham

2019-06-27 14:16:01 EDT

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.

Comment 3 Jonah Graham

2019-06-27 14:24:50 EDT

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.

Comment 4 Eclipse Genie

2019-06-27 14:35:38 EDT

New Gerrit change created: https://git.eclipse.org/r/145060

Comment 5 Mickael Istria

2019-06-27 15:08:38 EDT

Thanks Jonah!

Comment 6 Eclipse Genie

2019-06-27 15:09:04 EDT

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