From e8793592d9fcb69b3e9fb8c0a58df9c509402aac Mon Sep 17 00:00:00 2001
From: Jean-Noël Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Tue, 13 Oct 2015 07:43:46 +0000
Subject: [PATCH] Put all {@inheritDoc} javadocs on a single line
---
opendj-maven-plugin/src/main/resources/config/stylesheets/metaMO.xsl | 138 +++++++++++----------------------------------
opendj-maven-plugin/src/main/resources/config/stylesheets/property-types.xsl | 8 --
2 files changed, 37 insertions(+), 109 deletions(-)
diff --git a/opendj-maven-plugin/src/main/resources/config/stylesheets/metaMO.xsl b/opendj-maven-plugin/src/main/resources/config/stylesheets/metaMO.xsl
index 9b233e0..f8efe2a 100644
--- a/opendj-maven-plugin/src/main/resources/config/stylesheets/metaMO.xsl
+++ b/opendj-maven-plugin/src/main/resources/config/stylesheets/metaMO.xsl
@@ -153,7 +153,7 @@
<xsl:call-template name="generate-relation-constructor" />
</xsl:for-each>
<!--
- Register any optins associated with this managed object definition.
+ Register any options associated with this managed object definition.
-->
<xsl:if test="$this-is-advanced or $this-is-hidden">
<xsl:text>
</xsl:text>
@@ -276,9 +276,7 @@
Generate configuration client factory method.
-->
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public ',
$this-java-class,
'CfgClient createClientConfiguration(
',
@@ -296,9 +294,7 @@
Generate configuration server factory method.
-->
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public ',
$this-java-class,
'Cfg createServerConfiguration(
',
@@ -314,9 +310,7 @@
Generate configuration server class getter..
-->
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public Class<',
$this-java-class,
'Cfg> getServerConfigurationClass() {
',
@@ -434,9 +428,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public ManagedObjectDefinition<? extends ', $this-java-class,'CfgClient, ? extends ', $this-java-class,'Cfg> definition() {
',
' return INSTANCE;
',
' }
')" />
@@ -447,9 +439,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public PropertyProvider properties() {
',
' return impl;
',
' }
')" />
@@ -460,9 +450,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void commit() throws ManagedObjectAlreadyExistsException,
',
' MissingMandatoryPropertiesException, ConcurrentModificationException,
',
' OperationRejectedException, LdapException {
',
@@ -617,9 +605,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public Class<? extends ', $this-java-class,'Cfg> configurationClass() {
',
' return ', $this-java-class, 'Cfg.class;
',
' }
')" />
@@ -630,9 +616,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public DN dn() {
',
' return impl.getDN();
',
' }
')" />
@@ -1197,9 +1181,7 @@
<xsl:choose>
<xsl:when test="adm:one-to-one">
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public ', $java-class-name, 'CfgClient get', $java-relation-name, '()
',
' throws DefinitionDecodingException, ManagedObjectDecodingException,
',
' ManagedObjectNotFoundException, ConcurrentModificationException,
',
@@ -1209,9 +1191,7 @@
</xsl:when>
<xsl:when test="adm:one-to-zero-or-one">
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public boolean has', $java-relation-name, '() throws ConcurrentModificationException,
',
' LdapException {
',
' return impl.hasChild(INSTANCE.get', $java-relation-name,'RelationDefinition());
',
@@ -1220,9 +1200,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public ', $java-class-name, 'CfgClient get', $java-relation-name, '()
',
' throws DefinitionDecodingException, ManagedObjectDecodingException,
',
' ManagedObjectNotFoundException, ConcurrentModificationException,
',
@@ -1233,9 +1211,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public <M extends ', $java-class-name, 'CfgClient> M create', $java-relation-name, '(
',
' ManagedObjectDefinition<M, ? extends ', $java-class-name,'Cfg> d, Collection<PropertyException> exceptions) {
',
' return impl.createChild(INSTANCE.get', $java-relation-name,'RelationDefinition(), d, exceptions).getConfiguration();
',
@@ -1244,9 +1220,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void remove', $java-relation-name, '()
',
' throws ManagedObjectNotFoundException, ConcurrentModificationException,
',
' OperationRejectedException, LdapException {
',
@@ -1262,9 +1236,7 @@
</xsl:call-template>
</xsl:variable>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public String[] list', $java-relation-plural-name, '() throws ConcurrentModificationException,
',
' LdapException {
',
' return impl.listChildren(INSTANCE.get', $java-relation-plural-name,'RelationDefinition());
',
@@ -1273,9 +1245,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public ', $java-class-name, 'CfgClient get', $java-relation-name, '(String name)
',
' throws DefinitionDecodingException, ManagedObjectDecodingException,
',
' ManagedObjectNotFoundException, ConcurrentModificationException,
',
@@ -1288,9 +1258,7 @@
<xsl:choose>
<xsl:when test="string(adm:one-to-many/@unique) != 'true'">
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public <M extends ', $java-class-name, 'CfgClient> M create', $java-relation-name, '(
',
' ManagedObjectDefinition<M, ? extends ', $java-class-name,'Cfg> d, String name, Collection<PropertyException> exceptions) throws IllegalManagedObjectNameException {
',
' return impl.createChild(INSTANCE.get', $java-relation-plural-name,'RelationDefinition(), d, name, exceptions).getConfiguration();
',
@@ -1299,9 +1267,7 @@
<xsl:when test="string(adm:one-to-many/@unique) = 'true'">
<!-- Unique one-to-many children are named implicitly by their definition -->
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public <M extends ', $java-class-name, 'CfgClient> M create', $java-relation-name, '(
',
' ManagedObjectDefinition<M, ? extends ', $java-class-name,'Cfg> d, Collection<PropertyException> exceptions) {
',
' return impl.createChild(INSTANCE.get', $java-relation-plural-name,'RelationDefinition(), d, exceptions).getConfiguration();
',
@@ -1312,9 +1278,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void remove', $java-relation-name, '(String name)
',
' throws ManagedObjectNotFoundException, ConcurrentModificationException,
',
' OperationRejectedException, LdapException {
',
@@ -1347,9 +1311,7 @@
<xsl:choose>
<xsl:when test="adm:one-to-one">
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public ', $java-class-name, 'Cfg get',
$java-relation-name, '() throws ConfigException {
',
' return impl.getChild(INSTANCE.get', $java-relation-name, 'RelationDefinition()).getConfiguration();
',
@@ -1357,9 +1319,7 @@
</xsl:when>
<xsl:when test="adm:one-to-zero-or-one">
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public boolean has',
$java-relation-name, '() {
',
' return impl.hasChild(INSTANCE.get', $java-relation-name, 'RelationDefinition());
',
@@ -1368,9 +1328,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public ', $java-class-name, 'Cfg get',
$java-relation-name, '() throws ConfigException {
',
' return impl.getChild(INSTANCE.get', $java-relation-name, 'RelationDefinition()).getConfiguration();
',
@@ -1379,9 +1337,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void add', $java-relation-name, 'AddListener(
',
' ConfigurationAddListener<', $java-class-name,'Cfg> listener) throws ConfigException {
',
' impl.registerAddListener(INSTANCE.get', $java-relation-name, 'RelationDefinition(), listener);
',
@@ -1390,9 +1346,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void remove', $java-relation-name, 'AddListener(
',
' ConfigurationAddListener<', $java-class-name,'Cfg> listener) {
',
' impl.deregisterAddListener(INSTANCE.get', $java-relation-name, 'RelationDefinition(), listener);
',
@@ -1401,9 +1355,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void add', $java-relation-name, 'DeleteListener(
',
' ConfigurationDeleteListener<', $java-class-name,'Cfg> listener) throws ConfigException {
',
' impl.registerDeleteListener(INSTANCE.get', $java-relation-name, 'RelationDefinition(), listener);
',
@@ -1412,9 +1364,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void remove', $java-relation-name, 'DeleteListener(
',
' ConfigurationDeleteListener<', $java-class-name,'Cfg> listener) {
',
' impl.deregisterDeleteListener(INSTANCE.get', $java-relation-name, 'RelationDefinition(), listener);
',
@@ -1429,9 +1379,7 @@
</xsl:call-template>
</xsl:variable>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public String[] list',
$java-relation-plural-name, '() {
',
' return impl.listChildren(INSTANCE.get', $java-relation-plural-name,'RelationDefinition());
',
@@ -1440,9 +1388,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public ', $java-class-name, 'Cfg get',
$java-relation-name, '(String name) throws ConfigException {
',
' return impl.getChild(INSTANCE.get', $java-relation-plural-name, 'RelationDefinition(), name).getConfiguration();
',
@@ -1451,9 +1397,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void add', $java-relation-name, 'AddListener(
',
' ConfigurationAddListener<', $java-class-name,'Cfg> listener) throws ConfigException {
',
' impl.registerAddListener(INSTANCE.get', $java-relation-plural-name, 'RelationDefinition(), listener);
',
@@ -1462,9 +1406,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void remove', $java-relation-name, 'AddListener(
',
' ConfigurationAddListener<', $java-class-name,'Cfg> listener) {
',
' impl.deregisterAddListener(INSTANCE.get', $java-relation-plural-name, 'RelationDefinition(), listener);
',
@@ -1473,9 +1415,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void add', $java-relation-name, 'DeleteListener(
',
' ConfigurationDeleteListener<', $java-class-name,'Cfg> listener) throws ConfigException {
',
' impl.registerDeleteListener(INSTANCE.get', $java-relation-plural-name, 'RelationDefinition(), listener);
',
@@ -1484,9 +1424,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void remove', $java-relation-name, 'DeleteListener(
',
' ConfigurationDeleteListener<', $java-class-name,'Cfg> listener) {
',
' impl.deregisterDeleteListener(INSTANCE.get', $java-relation-plural-name, 'RelationDefinition(), listener);
',
@@ -1564,9 +1502,7 @@
</xsl:call-template>
</xsl:variable>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
')" />
+ select="concat(' /** {@inheritDoc} */
')" />
<xsl:value-of
select="concat(' public void add', $short-java-class, 'ChangeListener(
',
' ConfigurationChangeListener<',$java-class,'Cfg> listener) {
',
@@ -1576,9 +1512,7 @@
<xsl:text>
</xsl:text>
<xsl:text>
</xsl:text>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
')" />
+ select="concat(' /** {@inheritDoc} */
')" />
<xsl:value-of
select="concat(' public void remove', $short-java-class, 'ChangeListener(
',
' ConfigurationChangeListener<',$java-class,'Cfg> listener) {
',
@@ -1685,9 +1619,7 @@
'
',
'
',
'
',
- ' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ ' /** {@inheritDoc} */
',
' public String toString() { return name; }
')" />
<xsl:text>
</xsl:text>
<xsl:value-of select="' }
'" />
diff --git a/opendj-maven-plugin/src/main/resources/config/stylesheets/property-types.xsl b/opendj-maven-plugin/src/main/resources/config/stylesheets/property-types.xsl
index 8303e75..bbea77a 100644
--- a/opendj-maven-plugin/src/main/resources/config/stylesheets/property-types.xsl
+++ b/opendj-maven-plugin/src/main/resources/config/stylesheets/property-types.xsl
@@ -403,9 +403,7 @@
</xsl:call-template>
</xsl:variable>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public ')" />
<xsl:choose>
<xsl:when test="string(@multi-valued) != 'true'">
@@ -586,9 +584,7 @@
</xsl:call-template>
</xsl:variable>
<xsl:value-of
- select="concat(' /**
',
- ' * {@inheritDoc}
',
- ' */
',
+ select="concat(' /** {@inheritDoc} */
',
' public void set',
$java-prop-name ,
'(')" />
--
Gitblit v1.10.0