Allow to build api with Java 8

Java 8's javadoc fails hard on unknown HTML tags. Due some
documentation code snippets that contain generics and lacked a
{@code...}, the code got picked up as html, which made the target fail
like:

  [...]/extensions/registration/DynamicSet.java:64: error: unknown tag: Foo
   *   DynamicSet.setOf(binder(), new TypeLiteral<Thing<Foo>>() {});

We insert the needed {@code...} to make the build pass for Java 8.

Change-Id: I430b8eb9f2f158c2c7a2a7a8d93446eff3253529
This commit is contained in:
Christian Aistleitner
2015-03-29 14:07:15 +02:00
parent 19547b5ac6
commit 0da441ef87
11 changed files with 48 additions and 37 deletions

View File

@@ -239,13 +239,14 @@ public class PluginConfigFactory implements ReloadPluginListener {
/**
* Returns the configuration for the specified plugin that is stored in the
* plugin configuration file 'etc/<plugin-name>.config'.
* plugin configuration file '{@code etc/<plugin-name>.config}'.
*
* The plugin configuration is only loaded once and is then cached.
*
* @param pluginName the name of the plugin for which the configuration should
* be returned
* @return the plugin configuration from the 'etc/<plugin-name>.config' file
* @return the plugin configuration from the
* '{@code etc/<plugin-name>.config}' file
*/
public synchronized Config getGlobalPluginConfig(String pluginName) {
if (pluginConfigs.containsKey(pluginName)) {
@@ -274,15 +275,15 @@ public class PluginConfigFactory implements ReloadPluginListener {
/**
* Returns the configuration for the specified plugin that is stored in the
* '<plugin-name>.config' file in the 'refs/meta/config' branch of the
* specified project.
* '{@code <plugin-name>.config}' file in the 'refs/meta/config' branch of
* the specified project.
*
* @param projectName the name of the project for which the plugin
* configuration should be returned
* @param pluginName the name of the plugin for which the configuration should
* be returned
* @return the plugin configuration from the '<plugin-name>.config' file of
* the specified project
* @return the plugin configuration from the '{@code <plugin-name>.config}'
* file of the specified project
* @throws NoSuchProjectException thrown if the specified project does not
* exist
*/
@@ -293,15 +294,15 @@ public class PluginConfigFactory implements ReloadPluginListener {
/**
* Returns the configuration for the specified plugin that is stored in the
* '<plugin-name>.config' file in the 'refs/meta/config' branch of the
* specified project.
* '{@code <plugin-name>.config}' file in the 'refs/meta/config' branch of
* the specified project.
*
* @param projectState the project for which the plugin configuration should
* be returned
* @param pluginName the name of the plugin for which the configuration should
* be returned
* @return the plugin configuration from the '<plugin-name>.config' file of
* the specified project
* @return the plugin configuration from the '{@code <plugin-name>.config}'
* file of the specified project
*/
public Config getProjectPluginConfig(ProjectState projectState,
String pluginName) {
@@ -310,10 +311,10 @@ public class PluginConfigFactory implements ReloadPluginListener {
/**
* Returns the configuration for the specified plugin that is stored in the
* '<plugin-name>.config' file in the 'refs/meta/config' branch of the
* specified project. Parameters which are not set in the
* '<plugin-name>.config' of this project are inherited from the parent
* project's '<plugin-name>.config' files.
* '{@code <plugin-name>.config}' file in the 'refs/meta/config' branch of
* the specified project. Parameters which are not set in the
* '{@code <plugin-name>.config}' of this project are inherited from the
* parent project's '{@code <plugin-name>.config}' files.
*
* E.g.: child project: [mySection "mySubsection"] myKey = childValue
*
@@ -327,9 +328,9 @@ public class PluginConfigFactory implements ReloadPluginListener {
* configuration should be returned
* @param pluginName the name of the plugin for which the configuration should
* be returned
* @return the plugin configuration from the '<plugin-name>.config' file of
* the specified project with inheriting non-set parameters from the
* parent projects
* @return the plugin configuration from the '{@code <plugin-name>.config}'
* file of the specified project with inheriting non-set parameters
* from the parent projects
* @throws NoSuchProjectException thrown if the specified project does not
* exist
*/
@@ -340,10 +341,10 @@ public class PluginConfigFactory implements ReloadPluginListener {
/**
* Returns the configuration for the specified plugin that is stored in the
* '<plugin-name>.config' file in the 'refs/meta/config' branch of the
* specified project. Parameters which are not set in the
* '<plugin-name>.config' of this project are inherited from the parent
* project's '<plugin-name>.config' files.
* '{@code <plugin-name>.config}' file in the 'refs/meta/config' branch of
* the specified project. Parameters which are not set in the
* '{@code <plugin-name>.config}' of this project are inherited from the
* parent project's '{@code <plugin-name>.config}' files.
*
* E.g.: child project: [mySection "mySubsection"] myKey = childValue
*
@@ -357,9 +358,9 @@ public class PluginConfigFactory implements ReloadPluginListener {
* be returned
* @param pluginName the name of the plugin for which the configuration should
* be returned
* @return the plugin configuration from the '<plugin-name>.config' file of
* the specified project with inheriting non-set parameters from the
* parent projects
* @return the plugin configuration from the '{@code <plugin-name>.config}'
* file of the specified project with inheriting non-set parameters
* from the parent projects
*/
public Config getProjectPluginConfigWithInheritance(ProjectState projectState,
String pluginName) {