You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2024/03/07 14:01:28 UTC
(logging-log4j-tools) branch main updated: Migrate API references in AsciiDoc from `xref` to `apiref`
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-log4j-tools.git
The following commit(s) were added to refs/heads/main by this push:
new d9ccaf0 Migrate API references in AsciiDoc from `xref` to `apiref`
d9ccaf0 is described below
commit d9ccaf04712bbcdc65e14cd78da54812d10ec256
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Thu Mar 7 15:01:41 2024 +0100
Migrate API references in AsciiDoc from `xref` to `apiref`
---
.../processor/AbstractAsciiDocTreeVisitor.java | 33 ++-
.../AsciiDocConverterTest/JavadocExample.adoc | 2 +
.../AsciiDocConverterTest/JavadocExample.java | 3 +
.../DescriptorGeneratorTest/expected-plugins.xml | 6 +-
.../complex/descriptors/log4j-core-plugins.xml | 236 ++++++++++-----------
.../log4j-layout-template-json-plugins.xml | 48 ++---
.../org.apache.logging.log4j.core.Appender.adoc | 6 +-
.../org.apache.logging.log4j.core.Layout.adoc | 10 +-
.../org.apache.logging.log4j.core.LifeCycle.adoc | 8 +-
...org.apache.logging.log4j.core.StringLayout.adoc | 2 +-
...e.logging.log4j.core.appender.NullAppender.adoc | 2 +-
...e.logging.log4j.core.appender.SmtpAppender.adoc | 4 +-
...logging.log4j.core.appender.WriterAppender.adoc | 2 +-
...gging.log4j.core.appender.db.ColumnMapping.adoc | 10 +-
...jdbc.AbstractDriverManagerConnectionSource.adoc | 2 +-
...g.log4j.core.appender.db.jdbc.ColumnConfig.adoc | 2 +-
...g4j.core.appender.db.jdbc.ConnectionSource.adoc | 4 +-
...ppender.db.jdbc.DataSourceConnectionSource.adoc | 2 +-
...nder.db.jdbc.DriverManagerConnectionSource.adoc | 2 +-
...nder.db.jdbc.FactoryMethodConnectionSource.adoc | 6 +-
...g.log4j.core.appender.db.jdbc.JdbcAppender.adoc | 4 +-
...ng.log4j.core.appender.nosql.NoSqlAppender.adoc | 2 +-
....appender.rolling.AbstractTriggeringPolicy.adoc | 2 +-
....core.appender.rolling.action.DeleteAction.adoc | 2 +-
...4j.core.appender.rolling.action.IfFileName.adoc | 4 +-
....rolling.action.PathSortByModificationTime.adoc | 2 +-
...re.appender.rolling.action.ScriptCondition.adoc | 10 +-
...log4j.core.async.ArrayBlockingQueueFactory.adoc | 2 +-
...ging.log4j.core.async.BlockingQueueFactory.adoc | 2 +-
...j.core.async.DisruptorBlockingQueueFactory.adoc | 2 +-
...g4j.core.async.JCToolsBlockingQueueFactory.adoc | 2 +-
...og4j.core.async.LinkedTransferQueueFactory.adoc | 2 +-
...ing.log4j.core.config.ConfigurationFactory.adoc | 4 +-
...convert.TypeConverters.BigDecimalConverter.adoc | 2 +-
...convert.TypeConverters.BigIntegerConverter.adoc | 2 +-
...ns.convert.TypeConverters.BooleanConverter.adoc | 2 +-
....convert.TypeConverters.ByteArrayConverter.adoc | 4 +-
...ugins.convert.TypeConverters.ByteConverter.adoc | 2 +-
....convert.TypeConverters.CharArrayConverter.adoc | 2 +-
....convert.TypeConverters.CharacterConverter.adoc | 2 +-
...ns.convert.TypeConverters.CharsetConverter.adoc | 2 +-
...gins.convert.TypeConverters.ClassConverter.adoc | 2 +-
...ins.convert.TypeConverters.DoubleConverter.adoc | 2 +-
...s.convert.TypeConverters.DurationConverter.adoc | 2 +-
...ugins.convert.TypeConverters.FileConverter.adoc | 2 +-
...gins.convert.TypeConverters.FloatConverter.adoc | 2 +-
...onvert.TypeConverters.InetAddressConverter.adoc | 2 +-
...ns.convert.TypeConverters.IntegerConverter.adoc | 2 +-
...gins.convert.TypeConverters.LevelConverter.adoc | 2 +-
...ugins.convert.TypeConverters.LongConverter.adoc | 2 +-
...ugins.convert.TypeConverters.PathConverter.adoc | 2 +-
...ns.convert.TypeConverters.PatternConverter.adoc | 2 +-
...t.TypeConverters.SecurityProviderConverter.adoc | 2 +-
...gins.convert.TypeConverters.ShortConverter.adoc | 2 +-
...ins.convert.TypeConverters.StringConverter.adoc | 2 +-
...lugins.convert.TypeConverters.UriConverter.adoc | 2 +-
...lugins.convert.TypeConverters.UrlConverter.adoc | 2 +-
...ugins.convert.TypeConverters.UuidConverter.adoc | 2 +-
...g.log4j.core.filter.DynamicThresholdFilter.adoc | 2 +-
...pache.logging.log4j.core.filter.Filterable.adoc | 2 +-
...logging.log4j.core.filter.LevelRangeFilter.adoc | 10 +-
...ache.logging.log4j.core.filter.RegexFilter.adoc | 2 +-
...he.logging.log4j.core.layout.MessageLayout.adoc | 2 +-
...he.logging.log4j.core.layout.PatternLayout.adoc | 4 +-
...logging.log4j.core.layout.SerializedLayout.adoc | 2 +-
...logging.log4j.core.lookup.ContextMapLookup.adoc | 2 +-
...pache.logging.log4j.core.net.SocketOptions.adoc | 46 ++--
...og4j.core.net.SocketPerformancePreferences.adoc | 4 +-
...g.log4j.core.pattern.ArrayPatternConverter.adoc | 2 +-
...og4j.core.pattern.FileDatePatternConverter.adoc | 2 +-
...ging.log4j.core.pattern.HighlightConverter.adoc | 2 +-
...json.resolver.CaseConverterResolverFactory.adoc | 2 +-
...plate.json.resolver.CounterResolverFactory.adoc | 2 +-
...te.json.resolver.EndOfBatchResolverFactory.adoc | 2 +-
...n.resolver.EventAdditionalFieldInterceptor.adoc | 2 +-
...emplate.json.resolver.EventResolverFactory.adoc | 2 +-
...ate.json.resolver.EventResolverInterceptor.adoc | 2 +-
...ate.json.resolver.ExceptionResolverFactory.adoc | 2 +-
...resolver.ExceptionRootCauseResolverFactory.adoc | 2 +-
...emplate.json.resolver.LevelResolverFactory.adoc | 2 +-
...mplate.json.resolver.LoggerResolverFactory.adoc | 2 +-
...plate.json.resolver.MainMapResolverFactory.adoc | 2 +-
....template.json.resolver.MapResolverFactory.adoc | 2 +-
...mplate.json.resolver.MarkerResolverFactory.adoc | 2 +-
...n.resolver.MessageParameterResolverFactory.adoc | 2 +-
...plate.json.resolver.MessageResolverFactory.adoc | 2 +-
...plate.json.resolver.PatternResolverFactory.adoc | 2 +-
...mplate.json.resolver.SourceResolverFactory.adoc | 2 +-
...late.json.resolver.TemplateResolverFactory.adoc | 2 +-
....json.resolver.TemplateResolverInterceptor.adoc | 2 +-
....resolver.ThreadContextDataResolverFactory.adoc | 2 +-
...resolver.ThreadContextStackResolverFactory.adoc | 2 +-
...mplate.json.resolver.ThreadResolverFactory.adoc | 2 +-
...ate.json.resolver.TimestampResolverFactory.adoc | 2 +-
...emplate.json.util.RecyclerFactoryConverter.adoc | 2 +-
95 files changed, 318 insertions(+), 294 deletions(-)
diff --git a/log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/AbstractAsciiDocTreeVisitor.java b/log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/AbstractAsciiDocTreeVisitor.java
index 0548451..a6434ff 100644
--- a/log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/AbstractAsciiDocTreeVisitor.java
+++ b/log4j-docgen/src/main/java/org/apache/logging/log4j/docgen/processor/AbstractAsciiDocTreeVisitor.java
@@ -17,7 +17,6 @@
package org.apache.logging.log4j.docgen.processor;
import static org.apache.commons.lang3.StringUtils.isEmpty;
-import static org.apache.commons.lang3.StringUtils.substringBefore;
import com.sun.source.doctree.DocTree;
import com.sun.source.doctree.EndElementTree;
@@ -29,6 +28,7 @@ import com.sun.source.doctree.TextTree;
import com.sun.source.util.SimpleDocTreeVisitor;
import java.util.ArrayList;
import java.util.regex.Pattern;
+import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.docgen.processor.internal.BlockImpl;
import org.apache.logging.log4j.docgen.processor.internal.CellImpl;
@@ -225,16 +225,35 @@ abstract class AbstractAsciiDocTreeVisitor extends SimpleDocTreeVisitor<Void, As
@Override
public Void visitLink(final LinkTree node, final AsciiDocData data) {
- final String className = substringBefore(node.getReference().getSignature(), '#');
- final String simpleName = StringUtils.substringAfterLast(className, '.');
- data.appendAdjustingSpace(" xref:")
- .append(className)
- .append(".adoc[")
- .append(simpleName)
+ final String referenceSignature = node.getReference().getSignature();
+ final String referenceLabel = linkLabelToAsciiDoc(node);
+ data.appendAdjustingSpace(" apiref:")
+ .append(referenceSignature)
+ .append("[")
+ .append(referenceLabel)
.append("]");
return super.visitLink(node, data);
}
+ private static String linkLabelToAsciiDoc(final LinkTree node) {
+ int[] labelTokenIndex = {0};
+ return node.getLabel().stream()
+ .map(labelToken -> {
+ if (!(labelToken instanceof TextTree)) {
+ final String message = String.format(
+ "Non-text labels in links are not allowed! "
+ + "That is, `{@link foo.bar.Baz awesome thing}` is allowed, whereas {@link foo.bar.Baz {@code doh}}` is not. "
+ + "While visiting link `%s`, label token at index %d found to be of unexpected type: `%s`",
+ node, labelTokenIndex[0], labelToken.getClass().getCanonicalName());
+ throw new IllegalArgumentException(message);
+ }
+ labelTokenIndex[0]++;
+ final TextTree textLabel = (TextTree) labelToken;
+ return textLabel.getBody();
+ })
+ .collect(Collectors.joining(" "));
+ }
+
@Override
public Void visitLiteral(final LiteralTree node, final AsciiDocData data) {
if (node.getKind() == DocTree.Kind.CODE) {
diff --git a/log4j-docgen/src/test/resources/AsciiDocConverterTest/JavadocExample.adoc b/log4j-docgen/src/test/resources/AsciiDocConverterTest/JavadocExample.adoc
index 7eafa53..5ae10e4 100644
--- a/log4j-docgen/src/test/resources/AsciiDocConverterTest/JavadocExample.adoc
+++ b/log4j-docgen/src/test/resources/AsciiDocConverterTest/JavadocExample.adoc
@@ -16,6 +16,8 @@ limitations under the License.
////
Example of JavaDoc to AsciiDoc conversion
+Link test: apiref:String#value()[isn't this awesome]?
+
We run the `javadoc` tool on this class to test conversion of JavaDoc comments to AsciiDoc.
This paragraph has two sentences.
diff --git a/log4j-docgen/src/test/resources/AsciiDocConverterTest/JavadocExample.java b/log4j-docgen/src/test/resources/AsciiDocConverterTest/JavadocExample.java
index 80e8fd4..3a81b05 100644
--- a/log4j-docgen/src/test/resources/AsciiDocConverterTest/JavadocExample.java
+++ b/log4j-docgen/src/test/resources/AsciiDocConverterTest/JavadocExample.java
@@ -19,6 +19,9 @@ package example;
/**
* Example of JavaDoc to AsciiDoc conversion
* <p>
+ * Link test: {@link String#value() isn't this awesome}?
+ * </p>
+ * <p>
* We run the {@code javadoc} tool on this class to test conversion of JavaDoc comments to AsciiDoc. This
* paragraph has two sentences.
* </p>
diff --git a/log4j-docgen/src/test/resources/DescriptorGeneratorTest/expected-plugins.xml b/log4j-docgen/src/test/resources/DescriptorGeneratorTest/expected-plugins.xml
index 3e4002f..5543aed 100644
--- a/log4j-docgen/src/test/resources/DescriptorGeneratorTest/expected-plugins.xml
+++ b/log4j-docgen/src/test/resources/DescriptorGeneratorTest/expected-plugins.xml
@@ -120,8 +120,8 @@ It has the following characteristics:
It also implements:
-* xref:Appender.adoc[],
-* xref:BaseAppender.adoc[]</description>
+* apiref:Appender[],
+* apiref:BaseAppender[]</description>
</plugin>
<plugin name="MyLayout" className="example.MyOldLayout">
<supertypes>
@@ -160,7 +160,7 @@ It also implements:
<description>A `short` attribute.</description>
</attribute>
<attribute name="stringAttr" required="true">
- <description>A xref:String.adoc[] attribute.</description>
+ <description>A apiref:String[] attribute.</description>
</attribute>
</attributes>
<elements>
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/descriptors/log4j-core-plugins.xml b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/descriptors/log4j-core-plugins.xml
index 3883cc7..ff07df2 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/descriptors/log4j-core-plugins.xml
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/descriptors/log4j-core-plugins.xml
@@ -561,7 +561,7 @@ Hopefully it is obvious that the Appenders must be configured to not suppress ex
</attributes>
<description>An Appender that ignores log events.
-Use for compatibility with version 1.2 and handy for composing a xref:ScriptAppenderSelector.adoc[].</description>
+Use for compatibility with version 1.2 and handy for composing a apiref:ScriptAppenderSelector[].</description>
</plugin>
<plugin name="OutputStream" className="org.apache.logging.log4j.core.appender.OutputStreamAppender">
<supertypes>
@@ -784,12 +784,12 @@ Defaults to "smtp".</description>
<element type="org.apache.logging.log4j.core.Filter">
<description>Specifies the filter used for this appender.
-By default, uses a xref:ThresholdFilter.adoc[] with a level of ERROR.</description>
+By default, uses a apiref:ThresholdFilter[] with a level of ERROR.</description>
</element>
<element type="org.apache.logging.log4j.core.Layout">
<description>Specifies the layout used for the email message body.
-By default, this uses the xref:HtmlLayout.adoc[].</description>
+By default, this uses the apiref:HtmlLayout[].</description>
</element>
<element multiplicity="*" type="org.apache.logging.log4j.core.config.Property"></element>
<element type="org.apache.logging.log4j.core.net.ssl.SslConfiguration">
@@ -921,7 +921,7 @@ Supports both TCP and UDP.</description>
<element type="org.apache.logging.log4j.core.Layout"></element>
<element multiplicity="*" type="org.apache.logging.log4j.core.config.Property"></element>
</elements>
- <description>Appends log events to a xref:Writer.adoc[].</description>
+ <description>Appends log events to a apiref:Writer[].</description>
</plugin>
<plugin name="ColumnMapping" className="org.apache.logging.log4j.core.appender.db.ColumnMapping">
<supertypes>
@@ -931,9 +931,9 @@ Supports both TCP and UDP.</description>
<attribute name="columnType" type="java.lang.Class" required="true">
<description>Class to convert value to before storing in database.
-If the type is compatible with xref:ThreadContextMap.adoc[] or xref:ReadOnlyStringMap.adoc[], then the MDC will be used.
-If the type is compatible with xref:ThreadContextStack.adoc[], then the NDC will be used.
-If the type is compatible with xref:Date.adoc[], then the event timestamp will be used.</description>
+If the type is compatible with apiref:ThreadContextMap[] or apiref:ReadOnlyStringMap[], then the MDC will be used.
+If the type is compatible with apiref:ThreadContextStack[], then the NDC will be used.
+If the type is compatible with apiref:Date[], then the event timestamp will be used.</description>
</attribute>
<attribute name="literal">
<description>Literal value to use for populating a column.
@@ -951,7 +951,7 @@ This is generally useful for functions, stored procedures, etc.
No escaping will be done on this value.</description>
</attribute>
<attribute name="pattern">
- <description>Pattern to use as a xref:PatternLayout.adoc[].
+ <description>Pattern to use as a apiref:PatternLayout[].
Convenient shorthand for xref:.adoc[] with a PatternLayout.</description>
</attribute>
@@ -966,7 +966,7 @@ Useful when combined with a xref:org.apache.logging.log4j.message.MapMessage.ado
<element type="org.apache.logging.log4j.core.StringLayout">
<description>Layout of value to write to database (before type conversion).
-Not applicable if xref:.adoc[] is a xref:ReadOnlyStringMap.adoc[], xref:ThreadContextMap.adoc[], or xref:ThreadContextStack.adoc[].</description>
+Not applicable if xref:.adoc[] is a apiref:ReadOnlyStringMap[], apiref:ThreadContextMap[], or xref:ThreadContextStack.adoc[].</description>
</element>
</elements>
<description>A configuration element for specifying a database column name mapping.</description>
@@ -988,7 +988,7 @@ Mutually exclusive with `pattern! =null` and `eventTimestamp=true`.</description
<description>The name of the database column as it exists within the database table.</description>
</attribute>
<attribute name="pattern">
- <description>The xref:PatternLayout.adoc[] pattern to insert in this column.
+ <description>The apiref:PatternLayout[] pattern to insert in this column.
Mutually exclusive with `literal! =null` and `eventTimestamp=true`</description>
</attribute>
@@ -1010,7 +1010,7 @@ Mutually exclusive with `literal! =null` and `eventTimestamp=true`</description>
Must start with java:/comp/env or environment-equivalent.</description>
</attribute>
</attributes>
- <description>A xref:JdbcAppender.adoc[] connection source that uses a xref:DataSource.adoc[] to connect to the database.</description>
+ <description>A apiref:JdbcAppender[] connection source that uses a apiref:DataSource[] to connect to the database.</description>
</plugin>
<plugin name="DriverManager" className="org.apache.logging.log4j.core.appender.db.jdbc.DriverManagerConnectionSource">
<supertypes>
@@ -1031,7 +1031,7 @@ Must start with java:/comp/env or environment-equivalent.</description>
<elements>
<element multiplicity="*" type="org.apache.logging.log4j.core.config.Property"></element>
</elements>
- <description>A xref:ConnectionSource.adoc[] that uses a JDBC connection string, a user name, and a password to call xref:DriverManager.adoc[].
+ <description>A apiref:ConnectionSource[] that uses a JDBC connection string, a user name, and a password to call apiref:DriverManager[].
This plugin does not provide any connection pooling unless it is available through the connection string and driver itself.
This handy to get you off the ground without having to deal with JNDI.</description>
@@ -1047,14 +1047,14 @@ This handy to get you off the ground without having to deal with JNDI.</descript
</supertypes>
<attributes>
<attribute name="class">
- <description>The name of a public class that contains a static method capable of returning either a xref:DataSource.adoc[] or a xref:Connection.adoc[].</description>
+ <description>The name of a public class that contains a static method capable of returning either a apiref:DataSource[] or a apiref:Connection[].</description>
</attribute>
<attribute name="method">
<description>The name of the public static method on the aforementioned class that returns the data source or connection.
-If this method returns a xref:Connection.adoc[], it should return a new connection every call.</description>
+If this method returns a apiref:Connection[], it should return a new connection every call.</description>
</attribute>
</attributes>
- <description>A xref:JdbcAppender.adoc[] connection source that uses a public static factory method to obtain a xref:Connection.adoc[] or xref:DataSource.adoc[].</description>
+ <description>A apiref:JdbcAppender[] connection source that uses a public static factory method to obtain a apiref:Connection[] or xref:DataSource.adoc[].</description>
</plugin>
<plugin name="JDBC" className="org.apache.logging.log4j.core.appender.db.jdbc.JdbcAppender">
<supertypes>
@@ -1096,8 +1096,8 @@ If this method returns a xref:Connection.adoc[], it should return a new connecti
</elements>
<description>This Appender writes logging events to a relational database using standard JDBC mechanisms.
-It takes a list of xref:ColumnConfig.adoc[]s and/or xref:ColumnMapping.adoc[]s with which it determines how to save the event data into the appropriate columns in the table.
-ColumnMapping is new as of Log4j 2.8 and supports xref:TypeConverter.adoc[] and persistence using xref:PreparedStatement.adoc[]. A xref:ConnectionSource.adoc[] plugin instance instructs the appender (and xref:JdbcDatabaseManager.adoc[]) how to connect to the database.
+It takes a list of apiref:ColumnConfig[]s and/or apiref:ColumnMapping[]s with which it determines how to save the event data into the appropriate columns in the table.
+ColumnMapping is new as of Log4j 2.8 and supports apiref:TypeConverter[] and persistence using apiref:PreparedStatement[]. A xref:ConnectionSource.adoc[] plugin instance instructs the appender (and xref:JdbcDatabaseManager.adoc[]) how to connect to the database.
This appender can be reconfigured at run time.</description>
</plugin>
<plugin name="JMS" className="org.apache.logging.log4j.core.appender.mom.JmsAppender">
@@ -1241,7 +1241,7 @@ Requires the JeroMQ jar (LGPL as of 0.3.5)</description>
</elements>
<description>This Appender writes logging events to a NoSQL database using a configured NoSQL provider.
-It requires implementations of xref:NoSqlObject.adoc[], xref:NoSqlConnection.adoc[], and xref:NoSqlProvider.adoc[] to "know" how to write events to the chosen NoSQL database.
+It requires implementations of apiref:NoSqlObject[], apiref:NoSqlConnection[], and xref:NoSqlProvider.adoc[] to "know" how to write events to the chosen NoSQL database.
For examples on how to write your own NoSQL provider, see the simple source code for the MongoDB and CouchDB providers.</description>
</plugin>
@@ -1535,7 +1535,7 @@ Default is false.</description>
<description>an array of path conditions (if more than one, they all need to accept a path before it is deleted).</description>
</element>
<element type="org.apache.logging.log4j.core.appender.rolling.action.PathSorter">
- <description>a plugin implementing the xref:PathSorter.adoc[] interface</description>
+ <description>a plugin implementing the apiref:PathSorter[] interface</description>
</element>
<element type="org.apache.logging.log4j.core.appender.rolling.action.ScriptCondition"></element>
</elements>
@@ -1621,8 +1621,8 @@ Corresponds to logical "OR".</description>
If both a regular expression and a glob pattern are specified the glob pattern is used and the regular expression is ignored.
-The regular expression is a pattern as defined by the xref:Pattern.adoc[] class.
-A glob is a simplified pattern expression described in xref:FileSystem.adoc[].</description>
+The regular expression is a pattern as defined by the apiref:Pattern[] class.
+A glob is a simplified pattern expression described in apiref:FileSystem[].</description>
</plugin>
<plugin name="IfLastModified" className="org.apache.logging.log4j.core.appender.rolling.action.IfLastModified">
<supertypes>
@@ -1666,7 +1666,7 @@ Must be a valid Duration.</description>
<description>if true, most recently modified paths should come first.</description>
</attribute>
</attributes>
- <description>xref:PathSorter.adoc[] that sorts path by their LastModified attribute.</description>
+ <description>apiref:PathSorter[] that sorts path by their LastModified attribute.</description>
</plugin>
<plugin name="PosixViewAttribute" className="org.apache.logging.log4j.core.appender.rolling.action.PosixViewAttributeAction">
<supertypes>
@@ -1698,21 +1698,21 @@ Allow to define file permissions, user and group for log files on POSIX supporte
<elements>
<element type="org.apache.logging.log4j.core.script.AbstractScript">
<description>The script to run.
-This may be a xref:org.apache.logging.log4j.core.script.Script.adoc[Script], a xref:ScriptFile.adoc[] or a xref:ScriptRef.adoc[]. The script must return a `List<PathWithAttributes>`. When the script is executed, it is provided the following bindings:
+This may be a xref:org.apache.logging.log4j.core.script.Script.adoc[Script], a apiref:ScriptFile[] or a apiref:ScriptRef[]. The script must return a `List<PathWithAttributes>`. When the script is executed, it is provided the following bindings:
-* basePath - the directory from where the xref:DeleteAction.adoc[] action started scanning for files to delete.
+* basePath - the directory from where the apiref:DeleteAction[] action started scanning for files to delete.
Can be used to relativize the paths in the pathList.
* pathList - a `java. util. List` containing xref:org.apache.logging.log4j.core.appender.rolling.action.PathWithAttributes.adoc[PathWithAttributes] objects.
(The script is free to modify and return this list.
)
* substitutor - a xref:org.apache.logging.log4j.core.lookup.StrSubstitutor.adoc[StrSubstitutor] that can be used to look up variables embedded in the base dir or other properties
-* statusLogger - the xref:StatusLogger.adoc[] that can be used to log events during script execution
+* statusLogger - the apiref:StatusLogger[] that can be used to log events during script execution
* any properties declared in the configuration</description>
</element>
</elements>
- <description>A condition of the xref:DeleteAction.adoc[] where a user-provided script selects the files to delete from a provided list.
+ <description>A condition of the apiref:DeleteAction[] where a user-provided script selects the files to delete from a provided list.
-The specified script may be a xref:org.apache.logging.log4j.core.script.Script.adoc[Script], a xref:ScriptFile.adoc[] or a xref:ScriptRef.adoc[].</description>
+The specified script may be a xref:org.apache.logging.log4j.core.script.Script.adoc[Script], a apiref:ScriptFile[] or a apiref:ScriptRef[].</description>
</plugin>
<plugin name="IdlePurgePolicy" className="org.apache.logging.log4j.core.appender.routing.IdlePurgePolicy">
<supertypes>
@@ -1798,7 +1798,7 @@ The pattern should contain one or more substitution patterns of the form "$${[ke
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.async.BlockingQueueFactory</supertype>
</supertypes>
- <description>Factory for creating instances of xref:ArrayBlockingQueue.adoc[].</description>
+ <description>Factory for creating instances of apiref:ArrayBlockingQueue[].</description>
</plugin>
<plugin name="asyncLogger" className="org.apache.logging.log4j.core.async.AsyncLoggerConfig">
<supertypes>
@@ -1881,7 +1881,7 @@ This means that even with immediateFlush=false, there will never be any items le
<attributes>
<attribute name="SpinPolicy" type="com.conversantmedia.util.concurrent.SpinPolicy"></attribute>
</attributes>
- <description>Factory for creating instances of xref:DisruptorBlockingQueue.adoc[].</description>
+ <description>Factory for creating instances of apiref:DisruptorBlockingQueue[].</description>
</plugin>
<plugin name="JCToolsBlockingQueue" className="org.apache.logging.log4j.core.async.JCToolsBlockingQueueFactory">
<supertypes>
@@ -1891,14 +1891,14 @@ This means that even with immediateFlush=false, there will never be any items le
<attributes>
<attribute name="WaitStrategy" type="org.apache.logging.log4j.core.async.JCToolsBlockingQueueFactory.WaitStrategy"></attribute>
</attributes>
- <description>Factory for creating instances of BlockingQueues backed by JCTools xref:MpscArrayQueue.adoc[].</description>
+ <description>Factory for creating instances of BlockingQueues backed by JCTools apiref:MpscArrayQueue[].</description>
</plugin>
<plugin name="LinkedTransferQueue" className="org.apache.logging.log4j.core.async.LinkedTransferQueueFactory">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.async.BlockingQueueFactory</supertype>
</supertypes>
- <description>Factory for creating instances of xref:LinkedTransferQueue.adoc[].</description>
+ <description>Factory for creating instances of apiref:LinkedTransferQueue[].</description>
</plugin>
<plugin name="AppenderRef" className="org.apache.logging.log4j.core.config.AppenderRef">
<supertypes>
@@ -2135,34 +2135,34 @@ This means that even with immediateFlush=false, there will never be any items le
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Parses a xref:String.adoc[] into a xref:BigDecimal.adoc[].</description>
+ <description>Parses a apiref:String[] into a apiref:BigDecimal[].</description>
</plugin>
<plugin name="BigInteger" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BigIntegerConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Parses a xref:String.adoc[] into a xref:BigInteger.adoc[].</description>
+ <description>Parses a apiref:String[] into a apiref:BigInteger[].</description>
</plugin>
<plugin name="Boolean" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BooleanConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Boolean.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Boolean[].</description>
</plugin>
<plugin name="ByteArray" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteArrayConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a `byte[]`.
+ <description>Converts a apiref:String[] into a `byte[]`.
The supported formats are:
* 0x0123456789ABCDEF
* Base64:ABase64String
-* String using xref:Charset.adoc[] [TODO Should this be UTF-8 instead?
+* String using apiref:Charset[] [TODO Should this be UTF-8 instead?
]</description>
</plugin>
<plugin name="Byte" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteConverter">
@@ -2170,35 +2170,35 @@ The supported formats are:
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Byte.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Byte[].</description>
</plugin>
<plugin name="CharacterArray" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharArrayConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a `char[]`.</description>
+ <description>Converts a apiref:String[] into a `char[]`.</description>
</plugin>
<plugin name="Character" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharacterConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Character.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Character[].</description>
</plugin>
<plugin name="Charset" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharsetConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Charset.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Charset[].</description>
</plugin>
<plugin name="Class" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ClassConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Class.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Class[].</description>
</plugin>
<plugin name="CronExpression" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CronExpressionConverter">
<supertypes>
@@ -2211,49 +2211,49 @@ The supported formats are:
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Double.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Double[].</description>
</plugin>
<plugin name="Duration" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.DurationConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Duration.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Duration[].</description>
</plugin>
<plugin name="File" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FileConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:File.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:File[].</description>
</plugin>
<plugin name="Float" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FloatConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Float.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Float[].</description>
</plugin>
<plugin name="InetAddress" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.InetAddressConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into an xref:InetAddress.adoc[].</description>
+ <description>Converts a apiref:String[] into an apiref:InetAddress[].</description>
</plugin>
<plugin name="Integer" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.IntegerConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Integer.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Integer[].</description>
</plugin>
<plugin name="Level" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.LevelConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a Log4j xref:Level.adoc[].
+ <description>Converts a apiref:String[] into a Log4j apiref:Level[].
Returns `null` for invalid level names.</description>
</plugin>
@@ -2262,63 +2262,63 @@ Returns `null` for invalid level names.</description>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Long.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Long[].</description>
</plugin>
<plugin name="Path" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PathConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Path.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Path[].</description>
</plugin>
<plugin name="Pattern" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PatternConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Pattern.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Pattern[].</description>
</plugin>
<plugin name="SecurityProvider" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.SecurityProviderConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Provider.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Provider[].</description>
</plugin>
<plugin name="Short" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ShortConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:Short.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:Short[].</description>
</plugin>
<plugin name="String" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.StringConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Returns the given xref:String.adoc[], no conversion takes place.</description>
+ <description>Returns the given apiref:String[], no conversion takes place.</description>
</plugin>
<plugin name="URI" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UriConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:URI.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:URI[].</description>
</plugin>
<plugin name="URL" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UrlConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:URL.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:URL[].</description>
</plugin>
<plugin name="UUID" namespace="TypeConverter" className="org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UuidConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>Converts a xref:String.adoc[] into a xref:UUID.adoc[].</description>
+ <description>Converts a apiref:String[] into a apiref:UUID[].</description>
</plugin>
<plugin name="PropertiesConfigurationFactory" namespace="ConfigurationFactory" className="org.apache.logging.log4j.core.config.properties.PropertiesConfigurationFactory">
<supertypes>
@@ -2454,7 +2454,7 @@ DENY.</description>
</elements>
<description>Compares against a log level that is associated with a context value.
-By default the context is the xref:ThreadContext.adoc[], but users may xref:ContextDataInjectorFactory.adoc[] a custom xref:ContextDataInjector.adoc[] which obtains context data from some other source.</description>
+By default the context is the apiref:ThreadContext[], but users may apiref:ContextDataInjectorFactory[] a custom xref:ContextDataInjector.adoc[] which obtains context data from some other source.</description>
</plugin>
<plugin name="LevelMatchFilter" className="org.apache.logging.log4j.core.filter.LevelMatchFilter">
<supertypes>
@@ -2507,13 +2507,13 @@ DENY.</description>
<description>the result to return on a mismatch</description>
</attribute>
</attributes>
- <description>This filter returns the xref:.adoc[] result if the level of the xref:LogEvent.adoc[] is in the range of the configured xref:.adoc[] and xref:.adoc[] values, otherwise it returns the xref:.adoc[] result.
+ <description>This filter returns the xref:.adoc[] result if the level of the apiref:LogEvent[] is in the range of the configured xref:.adoc[] and xref:.adoc[] values, otherwise it returns the xref:.adoc[] result.
-The default values for xref:.adoc[] and xref:.adoc[] are set to xref:Level.adoc[] and xref:Level.adoc[], respectively.
-The default values for xref:.adoc[] and xref:.adoc[] are set to xref:Result.adoc[] and xref:Result.adoc[], respectively.
+The default values for xref:.adoc[] and xref:.adoc[] are set to apiref:Level[] and apiref:Level[], respectively.
+The default values for xref:.adoc[] and xref:.adoc[] are set to apiref:Result[] and apiref:Result[], respectively.
-The levels get compared by their associated integral values; xref:Level.adoc[] has an integral value of 0, xref:Level.adoc[] 100, xref:Level.adoc[] 200, and so on.
-For example, if the filter is configured with xref:.adoc[] set to xref:Level.adoc[], the filter will return xref:.adoc[] result for xref:LogEvent.adoc[]s of level with higher integral values; xref:Level.adoc[], xref:Level.adoc[], etc.</description>
+The levels get compared by their associated integral values; apiref:Level[] has an integral value of 0, apiref:Level[] 100, xref:Level.adoc[] 200, and so on.
+For example, if the filter is configured with xref:.adoc[] set to apiref:Level[], the filter will return xref:.adoc[] result for apiref:LogEvent[]s of level with higher integral values; xref:Level.adoc[], xref:Level.adoc[], etc.</description>
</plugin>
<plugin name="MapFilter" className="org.apache.logging.log4j.core.filter.MapFilter">
<supertypes>
@@ -2637,7 +2637,7 @@ DENY.</description>
</attributes>
<elements>
<element multiplicity="*" type="java.lang.String">
- <description>An array of Strings where each String is a xref:Pattern.adoc[] compilation flag.</description>
+ <description>An array of Strings where each String is a apiref:Pattern[] compilation flag.</description>
</element>
</elements>
<description>This filter returns the onMatch result if the message matches the regular expression.
@@ -3107,7 +3107,7 @@ Supports Lookup expressions.</description>
<supertype>org.apache.logging.log4j.core.layout.AbstractLayout</supertype>
<supertype>org.apache.logging.log4j.core.layout.Encoder</supertype>
</supertypes>
- <description>Formats a xref:LogEvent.adoc[] in its xref:Message.adoc[] form.
+ <description>Formats a apiref:LogEvent[] in its apiref:Message[] form.
Useful in combination with a JMS Appender to map a Log4j xref:org.apache.logging.log4j.message.MapMessage.adoc[MapMessage] or xref:org.apache.logging.log4j.message.StringMapMessage.adoc[StringMapMessage] to a JMS xref:javax.jms.MapMessage.adoc[MapMessage].</description>
</plugin>
@@ -3136,7 +3136,7 @@ The platform default is used if not specified.</description>
<description>The footer to place at the top of the document, once.</description>
</attribute>
<attribute name="noConsoleNoAnsi" type="boolean">
- <description>If `"true"` (default is false) and xref:System.adoc[] is null, do not output ANSI escape codes</description>
+ <description>If `"true"` (default is false) and apiref:System[] is null, do not output ANSI escape codes</description>
</attribute>
<attribute name="pattern">
<description>The pattern.
@@ -3162,7 +3162,7 @@ If not specified, defaults to DEFAULT_CONVERSION_PATTERN.</description>
</elements>
<description>A flexible layout configurable with pattern string.
-The goal of this class is to xref:org.apache.logging.log4j.core.Layout.adoc[Layout] a xref:LogEvent.adoc[] and return the results.
+The goal of this class is to xref:org.apache.logging.log4j.core.Layout.adoc[Layout] a apiref:LogEvent[] and return the results.
The format of the result depends on the _conversion pattern_.
The conversion pattern is closely related to the conversion pattern of the printf function in C. A conversion pattern is composed of literal text and format control expressions called _conversion specifiers_.
@@ -3276,7 +3276,7 @@ If no key is returned or there is no match the default pattern will be used.</de
<supertype>org.apache.logging.log4j.core.layout.AbstractLayout</supertype>
<supertype>org.apache.logging.log4j.core.layout.Encoder</supertype>
</supertypes>
- <description>Formats a xref:LogEvent.adoc[] in its Java serialized form.</description>
+ <description>Formats a apiref:LogEvent[] in its Java serialized form.</description>
</plugin>
<plugin name="SyslogLayout" className="org.apache.logging.log4j.core.layout.SyslogLayout">
<supertypes>
@@ -3421,7 +3421,7 @@ Supports Lookup expressions.</description>
</supertypes>
<description>Looks up keys from the context.
-By default this is the xref:ThreadContext.adoc[], but users may xref:ContextDataInjectorFactory.adoc[] a custom xref:ContextDataInjector.adoc[] which obtains context data from some other source.</description>
+By default this is the apiref:ThreadContext[], but users may apiref:ContextDataInjectorFactory[] a custom xref:ContextDataInjector.adoc[] which obtains context data from some other source.</description>
</plugin>
<plugin name="date" namespace="Lookup" className="org.apache.logging.log4j.core.lookup.DateLookup">
<supertypes>
@@ -3578,64 +3578,64 @@ Entries with names or values larger than 255 bytes will be removed prior to adve
</supertypes>
<attributes>
<attribute name="keepAlive" type="java.lang.Boolean">
- <description>See xref:Socket.adoc[].
+ <description>See apiref:Socket[].
-See xref:Socket.adoc[].</description>
+See apiref:Socket[].</description>
</attribute>
<attribute name="oobInline" type="java.lang.Boolean">
- <description>See xref:Socket.adoc[].
+ <description>See apiref:Socket[].
-See xref:Socket.adoc[].</description>
+See apiref:Socket[].</description>
</attribute>
<attribute name="receiveBufferSize" type="java.lang.Integer">
- <description>See xref:Socket.adoc[].
+ <description>See apiref:Socket[].
-See xref:Socket.adoc[].</description>
+See apiref:Socket[].</description>
</attribute>
<attribute name="reuseAddress" type="java.lang.Boolean">
- <description>See xref:Socket.adoc[].
+ <description>See apiref:Socket[].
-See xref:Socket.adoc[].</description>
+See apiref:Socket[].</description>
</attribute>
<attribute name="rfc1349TrafficClass" type="org.apache.logging.log4j.core.net.Rfc1349TrafficClass">
- <description>See xref:Socket.adoc[].
+ <description>See apiref:Socket[].
-See xref:Socket.adoc[].</description>
+See apiref:Socket[].</description>
</attribute>
<attribute name="sendBufferSize" type="java.lang.Integer">
- <description>See xref:Socket.adoc[].
+ <description>See apiref:Socket[].
-See xref:Socket.adoc[].</description>
+See apiref:Socket[].</description>
</attribute>
<attribute name="soLinger" type="java.lang.Integer">
- <description>See xref:Socket.adoc[].
+ <description>See apiref:Socket[].
-See xref:Socket.adoc[].</description>
+See apiref:Socket[].</description>
</attribute>
<attribute name="soTimeout" type="java.lang.Integer">
- <description>See xref:Socket.adoc[].
+ <description>See apiref:Socket[].
-See xref:Socket.adoc[].</description>
+See apiref:Socket[].</description>
</attribute>
<attribute name="tcpNoDelay" type="java.lang.Boolean">
- <description>See xref:Socket.adoc[].
+ <description>See apiref:Socket[].
-See xref:Socket.adoc[].</description>
+See apiref:Socket[].</description>
</attribute>
<attribute name="trafficClass" type="java.lang.Integer">
- <description>See xref:Socket.adoc[].
+ <description>See apiref:Socket[].
-See xref:Socket.adoc[].</description>
+See apiref:Socket[].</description>
</attribute>
</attributes>
<elements>
<element type="org.apache.logging.log4j.core.net.SocketPerformancePreferences">
- <description>See xref:Socket.adoc[].
+ <description>See apiref:Socket[].
-See xref:Socket.adoc[].</description>
+See apiref:Socket[].</description>
</element>
</elements>
- <description>Holds all socket options settable via xref:Socket.adoc[] methods.</description>
+ <description>Holds all socket options settable via apiref:Socket[] methods.</description>
</plugin>
<plugin name="SocketPerformancePreferences" className="org.apache.logging.log4j.core.net.SocketPerformancePreferences">
<supertypes>
@@ -3648,9 +3648,9 @@ See xref:Socket.adoc[].</description>
<attribute name="connectionTime" type="int" required="true"></attribute>
<attribute name="latency" type="int" required="true"></attribute>
</attributes>
- <description>Holds all socket options settable via xref:Socket.adoc[].
+ <description>Holds all socket options settable via apiref:Socket[].
-The xref:Socket.adoc[] API may not be implemented by a JRE.</description>
+The apiref:Socket[] API may not be implemented by a JRE.</description>
</plugin>
<plugin name="KeyStore" className="org.apache.logging.log4j.core.net.ssl.KeyStoreConfiguration">
<supertypes>
@@ -3897,7 +3897,7 @@ The extended stack trace will also include the location of where the class was l
<supertypes>
<supertype>java.lang.Object</supertype>
</supertypes>
- <description>Formats a date by delegating to xref:DatePatternConverter.adoc[].
+ <description>Formats a date by delegating to apiref:DatePatternConverter[].
The default date pattern for a %d specifier in a file name is different than the %d pattern in pattern layout.</description>
</plugin>
@@ -3961,7 +3961,7 @@ The available predefined styles are:
* `Logback`
You can use whitespace around the comma and equal sign.
-The names in values MUST come from the xref:AnsiEscape.adoc[] enum, case is normalized to upper-case internally.
+The names in values MUST come from the apiref:AnsiEscape[] enum, case is normalized to upper-case internally.
To disable ANSI output unconditionally, specify an additional option `disableAnsi=true`, or to disable ANSI output if no console is detected, specify option `noConsoleNoAnsi=true` e.g..
@@ -4309,12 +4309,12 @@ To disable ANSI output unconditionally, specify an additional option `disableAns
Wraps a xref:LifeCycle.State.adoc[State].</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.Appender">
- <description>Appends xref:LogEvent.adoc[]s.
+ <description>Appends apiref:LogEvent[]s.
-An Appender can contain a xref:Layout.adoc[] if applicable as well as an xref:ErrorHandler.adoc[]. Typical Appender implementations coordinate with an implementation of xref:org.apache.logging.log4j.core.appender.AbstractManager.adoc[AbstractManager] to handle external resources such as streams, connections, and other shared state.
+An Appender can contain a apiref:Layout[] if applicable as well as an apiref:ErrorHandler[]. Typical Appender implementations coordinate with an implementation of xref:org.apache.logging.log4j.core.appender.AbstractManager.adoc[AbstractManager] to handle external resources such as streams, connections, and other shared state.
As Appenders are plugins, concrete implementations need to be annotated with xref:org.apache.logging.log4j.core.config.plugins.Plugin.adoc[Plugin] and need to provide a static factory method annotated with xref:org.apache.logging.log4j.core.config.plugins.PluginFactory.adoc[PluginFactory].
-Most core plugins are written using a related Manager class that handle the actual task of serializing a xref:LogEvent.adoc[] to some output location.
+Most core plugins are written using a related Manager class that handle the actual task of serializing a apiref:LogEvent[] to some output location.
For instance, many Appenders can take advantage of the xref:org.apache.logging.log4j.core.appender.OutputStreamManager.adoc[OutputStreamManager] class.
It is recommended that Appenders don't do any heavy lifting since there can be many instances of the class being used at any given time.
@@ -4329,25 +4329,25 @@ This interface supports "global" filters (i.e. - all events must pass through th
It is recommended that, where possible, Filter implementations create a generic filtering method that can be called from any of the filter methods.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.Layout">
- <description>Lays out a xref:LogEvent.adoc[] in different formats.
+ <description>Lays out a apiref:LogEvent[] in different formats.
The formats are:
* `byte[]`
-* an implementer of xref:Serializable.adoc[], like `byte[]`
-* xref:String.adoc[]
-* xref:LogEvent.adoc[]
+* an implementer of apiref:Serializable[], like `byte[]`
+* apiref:String[]
+* apiref:LogEvent[]
-Since 2.6, Layouts can xref:Encoder.adoc[] a `LogEvent` directly to a xref:ByteBufferDestination.adoc[] without creating temporary intermediary objects.</description>
+Since 2.6, Layouts can apiref:Encoder[] a `LogEvent` directly to a apiref:ByteBufferDestination[] without creating temporary intermediary objects.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.LifeCycle">
<description>All proper Java frameworks implement some sort of object life cycle.
In Log4j, the main interface for handling the life cycle context of an object is this one.
-An object first starts in the xref:State.adoc[] state by default to indicate the class has been loaded.
-From here, calling the xref:.adoc[] method will change this state to xref:State.adoc[]. After successfully being started, this state is changed to xref:State.adoc[]. When the xref:.adoc[] is called, this goes into the xref:State.adoc[] state.
-After successfully being stopped, this goes into the xref:State.adoc[] state.
-In most circumstances, implementation classes should store their xref:State.adoc[] in a `volatile` field or inside an xref:java.util.concurrent.atomic.AtomicReference.adoc[AtomicReference] dependent on synchronization and concurrency requirements.</description>
+An object first starts in the apiref:State[] state by default to indicate the class has been loaded.
+From here, calling the xref:.adoc[] method will change this state to apiref:State[]. After successfully being started, this state is changed to apiref:State[]. When the xref:.adoc[] is called, this goes into the xref:State.adoc[] state.
+After successfully being stopped, this goes into the apiref:State[] state.
+In most circumstances, implementation classes should store their apiref:State[] in a `volatile` field or inside an xref:java.util.concurrent.atomic.AtomicReference.adoc[AtomicReference] dependent on synchronization and concurrency requirements.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.LifeCycle2">
<description>Extends the LifeCycle interface.
@@ -4355,7 +4355,7 @@ In most circumstances, implementation classes should store their xref:State.adoc
This interface should be merged with the super-interface in 3.0.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.StringLayout">
- <description>Instantiates the xref:Layout.adoc[] type for String-based layouts.</description>
+ <description>Instantiates the apiref:Layout[] type for String-based layouts.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.appender.AbstractAppender">
<description>Abstract base class for Appenders.
@@ -4382,22 +4382,22 @@ All database appenders should inherit from this base appender.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.appender.db.jdbc.AbstractConnectionSource"></abstractType>
<abstractType className="org.apache.logging.log4j.core.appender.db.jdbc.AbstractDriverManagerConnectionSource">
- <description>A xref:ConnectionSource.adoc[] that uses a JDBC connection string, a user name, and a password to call xref:DriverManager.adoc[].
+ <description>A apiref:ConnectionSource[] that uses a JDBC connection string, a user name, and a password to call apiref:DriverManager[].
This plugin does not provide any connection pooling unless it is available through the connection string and driver itself.
This handy to get you off the ground without having to deal with JNDI.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource">
- <description>Configuration element for xref:JdbcAppender.adoc[].
+ <description>Configuration element for apiref:JdbcAppender[].
-If you want to use the xref:JdbcAppender.adoc[] but none of the provided connection sources meet your needs, you can simply create your own connection source.</description>
+If you want to use the apiref:JdbcAppender[] but none of the provided connection sources meet your needs, you can simply create your own connection source.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.appender.rewrite.RewritePolicy">
<description>Interface to be implemented by components that support modifications to the LogEvent.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.appender.rolling.AbstractRolloverStrategy"></abstractType>
<abstractType className="org.apache.logging.log4j.core.appender.rolling.AbstractTriggeringPolicy">
- <description>Abstract convenience class for triggering policies that extend xref:AbstractLifeCycle.adoc[] and implement xref:TriggeringPolicy.adoc[].</description>
+ <description>Abstract convenience class for triggering policies that extend apiref:AbstractLifeCycle[] and implement apiref:TriggeringPolicy[].</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.appender.rolling.DirectFileRolloverStrategy">
<description>Created by rgoers on 1/12/17.</description>
@@ -4429,13 +4429,13 @@ Such conditions include time of day, file size, an external event, the log reque
<description>Policy for purging routed appenders</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.async.BlockingQueueFactory">
- <description>Factory for creating instances of xref:BlockingQueue.adoc[].</description>
+ <description>Factory for creating instances of apiref:BlockingQueue[].</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.config.ConfigurationAware">
<description>Indicates that a class requests the current Configuration to be injected.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.config.ConfigurationFactory">
- <description>Factory class for parsed xref:Configuration.adoc[] objects from a configuration file.
+ <description>Factory class for parsed apiref:Configuration[] objects from a configuration file.
ConfigurationFactory allows the configuration implementation to be dynamically chosen in 1 of 3 ways:
@@ -4444,7 +4444,7 @@ configurationFactory" can be set with the name of the ConfigurationFactory to be
. xref:.adoc[] can be called with the instance of the ConfigurationFactory to be used.
This must be called before any other calls to Log4j.
. A ConfigurationFactory implementation can be added to the classpath and configured as a plugin in the xref:.adoc[] category.
-The xref:Order.adoc[] annotation should be used to configure the factory to be the first one inspected.
+The apiref:Order[] annotation should be used to configure the factory to be the first one inspected.
See xref:org.apache.logging.log4j.core.config.xml.XmlConfigurationFactory.adoc[XmlConfigurationFactory] for an example.
If the ConfigurationFactory that was added returns null on a call to getConfiguration then any other ConfigurationFactories found as plugins will be called in their respective order.
@@ -4476,7 +4476,7 @@ Garbage-free note: the methods with unrolled varargs by default delegate to the
<abstractType className="org.apache.logging.log4j.core.filter.Filterable">
<description>Interface implemented by Classes that allow filtering to occur.
-Extends xref:LifeCycle.adoc[] since filters have a life cycle.</description>
+Extends apiref:LifeCycle[] since filters have a life cycle.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.filter.MapFilter">
<description>A Filter that operates on a Map.</description>
@@ -4546,7 +4546,7 @@ Adds ANSI color styling to the result of the enclosed pattern.</description>
<description>Marks classes that implement ANSI escape code conversions.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.pattern.ArrayPatternConverter">
- <description>xref:PatternConverter.adoc[]s implement this interface to accept an array of objects when formatting.</description>
+ <description>apiref:PatternConverter[]s implement this interface to accept an array of objects when formatting.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.core.pattern.EqualsBaseReplacementConverter">
<description>Equals pattern converter.</description>
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/descriptors/log4j-layout-template-json-plugins.xml b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/descriptors/log4j-layout-template-json-plugins.xml
index 802f24b..f6cc80e 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/descriptors/log4j-layout-template-json-plugins.xml
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/descriptors/log4j-layout-template-json-plugins.xml
@@ -74,7 +74,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:CaseConverterResolver.adoc[] factory.</description>
+ <description>apiref:CaseConverterResolver[] factory.</description>
</plugin>
<plugin name="CounterResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.CounterResolverFactory">
<supertypes>
@@ -82,7 +82,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:CounterResolver.adoc[] factory.</description>
+ <description>apiref:CounterResolver[] factory.</description>
</plugin>
<plugin name="EndOfBatchResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.EndOfBatchResolverFactory">
<supertypes>
@@ -90,7 +90,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:EndOfBatchResolver.adoc[] factory.</description>
+ <description>apiref:EndOfBatchResolver[] factory.</description>
</plugin>
<plugin name="EventAdditionalFieldInterceptor" namespace="JsonTemplateResolverInterceptor" className="org.apache.logging.log4j.layout.template.json.resolver.EventAdditionalFieldInterceptor">
<supertypes>
@@ -98,7 +98,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverInterceptor</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverInterceptor</supertype>
</supertypes>
- <description>Interceptor to add xref:EventTemplateAdditionalField.adoc[] after event template read.</description>
+ <description>Interceptor to add apiref:EventTemplateAdditionalField[] after event template read.</description>
</plugin>
<plugin name="EventRootObjectKeyInterceptor" namespace="JsonTemplateResolverInterceptor" className="org.apache.logging.log4j.layout.template.json.resolver.EventRootObjectKeyInterceptor">
<supertypes>
@@ -114,7 +114,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:ExceptionResolver.adoc[] factory.</description>
+ <description>apiref:ExceptionResolver[] factory.</description>
</plugin>
<plugin name="ExceptionRootCauseResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.ExceptionRootCauseResolverFactory">
<supertypes>
@@ -122,7 +122,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:ExceptionRootCauseResolver.adoc[] factory.</description>
+ <description>apiref:ExceptionRootCauseResolver[] factory.</description>
</plugin>
<plugin name="LevelResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.LevelResolverFactory">
<supertypes>
@@ -130,7 +130,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:LevelResolver.adoc[] factory.</description>
+ <description>apiref:LevelResolver[] factory.</description>
</plugin>
<plugin name="LoggerResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.LoggerResolverFactory">
<supertypes>
@@ -138,7 +138,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:LoggerResolver.adoc[] factory.</description>
+ <description>apiref:LoggerResolver[] factory.</description>
</plugin>
<plugin name="MainMapResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.MainMapResolverFactory">
<supertypes>
@@ -146,7 +146,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:MainMapResolver.adoc[] factory.</description>
+ <description>apiref:MainMapResolver[] factory.</description>
</plugin>
<plugin name="MapResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.MapResolverFactory">
<supertypes>
@@ -154,7 +154,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:MapResolver.adoc[] factory.</description>
+ <description>apiref:MapResolver[] factory.</description>
</plugin>
<plugin name="MarkerResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.MarkerResolverFactory">
<supertypes>
@@ -162,7 +162,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:MarkerResolver.adoc[] factory.</description>
+ <description>apiref:MarkerResolver[] factory.</description>
</plugin>
<plugin name="MessageParameterResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.MessageParameterResolverFactory">
<supertypes>
@@ -170,7 +170,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:MessageParameterResolver.adoc[] factory.</description>
+ <description>apiref:MessageParameterResolver[] factory.</description>
</plugin>
<plugin name="MessageResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.MessageResolverFactory">
<supertypes>
@@ -178,7 +178,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>A xref:MessageResolver.adoc[] factory.</description>
+ <description>A apiref:MessageResolver[] factory.</description>
</plugin>
<plugin name="PatternResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.PatternResolverFactory">
<supertypes>
@@ -186,7 +186,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:PatternResolver.adoc[] factory.</description>
+ <description>apiref:PatternResolver[] factory.</description>
</plugin>
<plugin name="SourceResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.SourceResolverFactory">
<supertypes>
@@ -194,7 +194,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:SourceResolver.adoc[] factory.</description>
+ <description>apiref:SourceResolver[] factory.</description>
</plugin>
<plugin name="ThreadContextDataResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.ThreadContextDataResolverFactory">
<supertypes>
@@ -202,7 +202,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:ThreadContextDataResolver.adoc[] factory.</description>
+ <description>apiref:ThreadContextDataResolver[] factory.</description>
</plugin>
<plugin name="ThreadContextStackResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.ThreadContextStackResolverFactory">
<supertypes>
@@ -210,7 +210,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:ThreadContextStackResolver.adoc[] factory.</description>
+ <description>apiref:ThreadContextStackResolver[] factory.</description>
</plugin>
<plugin name="ThreadResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.ThreadResolverFactory">
<supertypes>
@@ -218,7 +218,7 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:ThreadResolver.adoc[] factory.</description>
+ <description>apiref:ThreadResolver[] factory.</description>
</plugin>
<plugin name="TimestampResolverFactory" namespace="JsonTemplateResolverFactory" className="org.apache.logging.log4j.layout.template.json.resolver.TimestampResolverFactory">
<supertypes>
@@ -226,14 +226,14 @@
<supertype>org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory</supertype>
<supertype>org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory</supertype>
</supertypes>
- <description>xref:TimestampResolver.adoc[] factory.</description>
+ <description>apiref:TimestampResolver[] factory.</description>
</plugin>
<plugin name="RecyclerFactoryConverter" namespace="TypeConverter" className="org.apache.logging.log4j.layout.template.json.util.RecyclerFactoryConverter">
<supertypes>
<supertype>java.lang.Object</supertype>
<supertype>org.apache.logging.log4j.core.config.plugins.convert.TypeConverter</supertype>
</supertypes>
- <description>The default string (i.e., recycler factory spec) to xref:RecyclerFactory.adoc[] type converter.</description>
+ <description>The default string (i.e., recycler factory spec) to apiref:RecyclerFactory[] type converter.</description>
</plugin>
</plugins>
<abstractTypes>
@@ -243,16 +243,16 @@
<abstractType className="org.apache.logging.log4j.core.impl.LocationAware"></abstractType>
<abstractType className="org.apache.logging.log4j.core.layout.Encoder"></abstractType>
<abstractType className="org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory">
- <description>xref:TemplateResolverFactory.adoc[] specialized for xref:LogEvent.adoc[]s.</description>
+ <description>apiref:TemplateResolverFactory[] specialized for apiref:LogEvent[]s.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.layout.template.json.resolver.EventResolverInterceptor">
- <description>xref:TemplateResolverInterceptor.adoc[] specialized for xref:LogEvent.adoc[]s.</description>
+ <description>apiref:TemplateResolverInterceptor[] specialized for apiref:LogEvent[]s.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory">
- <description>xref:TemplateResolver.adoc[] factory.</description>
+ <description>apiref:TemplateResolver[] factory.</description>
</abstractType>
<abstractType className="org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverInterceptor">
- <description>Main xref:TemplateResolver.adoc[] compilation interception interface.</description>
+ <description>Main apiref:TemplateResolver[] compilation interception interface.</description>
</abstractType>
</abstractTypes>
</pluginSet>
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.Appender.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.Appender.adoc
index a061412..9c8946c 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.Appender.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.Appender.adoc
@@ -22,12 +22,12 @@ Class:: `org.apache.logging.log4j.core.Appender`
Provider:: `org.apache.logging.log4j:log4j-core`
-Appends xref:LogEvent.adoc[]s.
+Appends apiref:LogEvent[]s.
-An Appender can contain a xref:Layout.adoc[] if applicable as well as an xref:ErrorHandler.adoc[]. Typical Appender implementations coordinate with an implementation of xref:org.apache.logging.log4j.core.appender.AbstractManager.adoc[AbstractManager] to handle external resources such as streams, connections, and other shared state.
+An Appender can contain a apiref:Layout[] if applicable as well as an apiref:ErrorHandler[]. Typical Appender implementations coordinate with an implementation of xref:org.apache.logging.log4j.core.appender.AbstractManager.adoc[AbstractManager] to handle external resources such as streams, connections, and other shared state.
As Appenders are plugins, concrete implementations need to be annotated with xref:org.apache.logging.log4j.core.config.plugins.Plugin.adoc[Plugin] and need to provide a static factory method annotated with xref:org.apache.logging.log4j.core.config.plugins.PluginFactory.adoc[PluginFactory].
-Most core plugins are written using a related Manager class that handle the actual task of serializing a xref:LogEvent.adoc[] to some output location.
+Most core plugins are written using a related Manager class that handle the actual task of serializing a apiref:LogEvent[] to some output location.
For instance, many Appenders can take advantage of the xref:org.apache.logging.log4j.core.appender.OutputStreamManager.adoc[OutputStreamManager] class.
It is recommended that Appenders don't do any heavy lifting since there can be many instances of the class being used at any given time.
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.Layout.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.Layout.adoc
index eba9dc6..2624249 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.Layout.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.Layout.adoc
@@ -22,16 +22,16 @@ Class:: `org.apache.logging.log4j.core.Layout`
Provider:: `org.apache.logging.log4j:log4j-core`
-Lays out a xref:LogEvent.adoc[] in different formats.
+Lays out a apiref:LogEvent[] in different formats.
The formats are:
* `byte[]`
-* an implementer of xref:Serializable.adoc[], like `byte[]`
-* xref:String.adoc[]
-* xref:LogEvent.adoc[]
+* an implementer of apiref:Serializable[], like `byte[]`
+* apiref:String[]
+* apiref:LogEvent[]
-Since 2.6, Layouts can xref:Encoder.adoc[] a `LogEvent` directly to a xref:ByteBufferDestination.adoc[] without creating temporary intermediary objects.
+Since 2.6, Layouts can apiref:Encoder[] a `LogEvent` directly to a apiref:ByteBufferDestination[] without creating temporary intermediary objects.
[#org_apache_logging_log4j_core_Layout-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.LifeCycle.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.LifeCycle.adoc
index e952ac0..4bd1ebf 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.LifeCycle.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.LifeCycle.adoc
@@ -25,10 +25,10 @@ Provider:: `org.apache.logging.log4j:log4j-core`
All proper Java frameworks implement some sort of object life cycle.
In Log4j, the main interface for handling the life cycle context of an object is this one.
-An object first starts in the xref:State.adoc[] state by default to indicate the class has been loaded.
-From here, calling the xref:.adoc[] method will change this state to xref:State.adoc[]. After successfully being started, this state is changed to xref:State.adoc[]. When the xref:.adoc[] is called, this goes into the xref:State.adoc[] state.
-After successfully being stopped, this goes into the xref:State.adoc[] state.
-In most circumstances, implementation classes should store their xref:State.adoc[] in a `volatile` field or inside an xref:java.util.concurrent.atomic.AtomicReference.adoc[AtomicReference] dependent on synchronization and concurrency requirements.
+An object first starts in the apiref:State[] state by default to indicate the class has been loaded.
+From here, calling the xref:.adoc[] method will change this state to apiref:State[]. After successfully being started, this state is changed to apiref:State[]. When the xref:.adoc[] is called, this goes into the xref:State.adoc[] state.
+After successfully being stopped, this goes into the apiref:State[] state.
+In most circumstances, implementation classes should store their apiref:State[] in a `volatile` field or inside an xref:java.util.concurrent.atomic.AtomicReference.adoc[AtomicReference] dependent on synchronization and concurrency requirements.
[#org_apache_logging_log4j_core_LifeCycle-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.StringLayout.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.StringLayout.adoc
index 8caace4..fe6ee30 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.StringLayout.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.StringLayout.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.StringLayout`
Provider:: `org.apache.logging.log4j:log4j-core`
-Instantiates the xref:Layout.adoc[] type for String-based layouts.
+Instantiates the apiref:Layout[] type for String-based layouts.
[#org_apache_logging_log4j_core_StringLayout-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.NullAppender.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.NullAppender.adoc
index 82ae807..bfd81a8 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.NullAppender.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.NullAppender.adoc
@@ -24,7 +24,7 @@ Provider:: `org.apache.logging.log4j:log4j-core`
An Appender that ignores log events.
-Use for compatibility with version 1.2 and handy for composing a xref:ScriptAppenderSelector.adoc[].
+Use for compatibility with version 1.2 and handy for composing a apiref:ScriptAppenderSelector[].
[#org_apache_logging_log4j_core_appender_NullAppender-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.SmtpAppender.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.SmtpAppender.adoc
index d365413..133026f 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.SmtpAppender.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.SmtpAppender.adoc
@@ -167,13 +167,13 @@ a|
|xref:../log4j-core/org.apache.logging.log4j.core.Filter.adoc[Filter]?
a|Specifies the filter used for this appender.
-By default, uses a xref:ThresholdFilter.adoc[] with a level of ERROR.
+By default, uses a apiref:ThresholdFilter[] with a level of ERROR.
|
|xref:../log4j-core/org.apache.logging.log4j.core.Layout.adoc[Layout]?
a|Specifies the layout used for the email message body.
-By default, this uses the xref:HtmlLayout.adoc[].
+By default, this uses the apiref:HtmlLayout[].
|Ssl
|xref:../log4j-core/org.apache.logging.log4j.core.net.ssl.SslConfiguration.adoc[SslConfiguration]?
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.WriterAppender.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.WriterAppender.adoc
index 1b9d220..3c95031 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.WriterAppender.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.WriterAppender.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.appender.WriterAppender`
Provider:: `org.apache.logging.log4j:log4j-core`
-Appends log events to a xref:Writer.adoc[].
+Appends log events to a apiref:Writer[].
[#org_apache_logging_log4j_core_appender_WriterAppender-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.ColumnMapping.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.ColumnMapping.adoc
index bd29f9b..5088bf6 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.ColumnMapping.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.ColumnMapping.adoc
@@ -53,9 +53,9 @@ Optional attributes are denoted by `?`-suffixed types.
|
a|Class to convert value to before storing in database.
-If the type is compatible with xref:ThreadContextMap.adoc[] or xref:ReadOnlyStringMap.adoc[], then the MDC will be used.
-If the type is compatible with xref:ThreadContextStack.adoc[], then the NDC will be used.
-If the type is compatible with xref:Date.adoc[], then the event timestamp will be used.
+If the type is compatible with apiref:ThreadContextMap[] or apiref:ReadOnlyStringMap[], then the MDC will be used.
+If the type is compatible with apiref:ThreadContextStack[], then the NDC will be used.
+If the type is compatible with apiref:Date[], then the event timestamp will be used.
|literal
|String?
@@ -81,7 +81,7 @@ No escaping will be done on this value.
|pattern
|String?
|
-a|Pattern to use as a xref:PatternLayout.adoc[].
+a|Pattern to use as a apiref:PatternLayout[].
Convenient shorthand for xref:.adoc[] with a PatternLayout.
@@ -112,6 +112,6 @@ Optional components are denoted by `?`-suffixed types.
|xref:../log4j-core/org.apache.logging.log4j.core.StringLayout.adoc[StringLayout]?
a|Layout of value to write to database (before type conversion).
-Not applicable if xref:.adoc[] is a xref:ReadOnlyStringMap.adoc[], xref:ThreadContextMap.adoc[], or xref:ThreadContextStack.adoc[].
+Not applicable if xref:.adoc[] is a apiref:ReadOnlyStringMap[], apiref:ThreadContextMap[], or xref:ThreadContextStack.adoc[].
|===
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.AbstractDriverManagerConnectionSource.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.AbstractDriverManagerConnectionSource.adoc
index b514b95..12d4184 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.AbstractDriverManagerConnectionSource.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.AbstractDriverManagerConnectionSource.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.appender.db.jdbc.AbstractDriverManagerCon
Provider:: `org.apache.logging.log4j:log4j-core`
-A xref:ConnectionSource.adoc[] that uses a JDBC connection string, a user name, and a password to call xref:DriverManager.adoc[].
+A apiref:ConnectionSource[] that uses a JDBC connection string, a user name, and a password to call apiref:DriverManager[].
This plugin does not provide any connection pooling unless it is available through the connection string and driver itself.
This handy to get you off the ground without having to deal with JNDI.
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig.adoc
index 2d30b3a..58d0800 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig.adoc
@@ -75,7 +75,7 @@ a|The name of the database column as it exists within the database table.
|pattern
|String?
|
-a|The xref:PatternLayout.adoc[] pattern to insert in this column.
+a|The apiref:PatternLayout[] pattern to insert in this column.
Mutually exclusive with `literal! =null` and `eventTimestamp=true`
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource.adoc
index 0d66e2c..9635330 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource.adoc
@@ -22,9 +22,9 @@ Class:: `org.apache.logging.log4j.core.appender.db.jdbc.ConnectionSource`
Provider:: `org.apache.logging.log4j:log4j-core`
-Configuration element for xref:JdbcAppender.adoc[].
+Configuration element for apiref:JdbcAppender[].
-If you want to use the xref:JdbcAppender.adoc[] but none of the provided connection sources meet your needs, you can simply create your own connection source.
+If you want to use the apiref:JdbcAppender[] but none of the provided connection sources meet your needs, you can simply create your own connection source.
[#org_apache_logging_log4j_core_appender_db_jdbc_ConnectionSource-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.DataSourceConnectionSource.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.DataSourceConnectionSource.adoc
index 83241aa..05bf1dd 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.DataSourceConnectionSource.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.DataSourceConnectionSource.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.appender.db.jdbc.DataSourceConnectionSour
Provider:: `org.apache.logging.log4j:log4j-core`
-A xref:JdbcAppender.adoc[] connection source that uses a xref:DataSource.adoc[] to connect to the database.
+A apiref:JdbcAppender[] connection source that uses a apiref:DataSource[] to connect to the database.
[#org_apache_logging_log4j_core_appender_db_jdbc_DataSourceConnectionSource-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.DriverManagerConnectionSource.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.DriverManagerConnectionSource.adoc
index 95e90a1..2d56999 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.DriverManagerConnectionSource.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.DriverManagerConnectionSource.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.appender.db.jdbc.DriverManagerConnectionS
Provider:: `org.apache.logging.log4j:log4j-core`
-A xref:ConnectionSource.adoc[] that uses a JDBC connection string, a user name, and a password to call xref:DriverManager.adoc[].
+A apiref:ConnectionSource[] that uses a JDBC connection string, a user name, and a password to call apiref:DriverManager[].
This plugin does not provide any connection pooling unless it is available through the connection string and driver itself.
This handy to get you off the ground without having to deal with JNDI.
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.FactoryMethodConnectionSource.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.FactoryMethodConnectionSource.adoc
index f4ffd0e..d31f7d0 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.FactoryMethodConnectionSource.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.FactoryMethodConnectionSource.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.appender.db.jdbc.FactoryMethodConnectionS
Provider:: `org.apache.logging.log4j:log4j-core`
-A xref:JdbcAppender.adoc[] connection source that uses a public static factory method to obtain a xref:Connection.adoc[] or xref:DataSource.adoc[].
+A apiref:JdbcAppender[] connection source that uses a public static factory method to obtain a apiref:Connection[] or xref:DataSource.adoc[].
[#org_apache_logging_log4j_core_appender_db_jdbc_FactoryMethodConnectionSource-XML-snippet]
== XML snippet
@@ -44,12 +44,12 @@ Optional attributes are denoted by `?`-suffixed types.
|class
|String?
|
-a|The name of a public class that contains a static method capable of returning either a xref:DataSource.adoc[] or a xref:Connection.adoc[].
+a|The name of a public class that contains a static method capable of returning either a apiref:DataSource[] or a apiref:Connection[].
|method
|String?
|
a|The name of the public static method on the aforementioned class that returns the data source or connection.
-If this method returns a xref:Connection.adoc[], it should return a new connection every call.
+If this method returns a apiref:Connection[], it should return a new connection every call.
|===
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.JdbcAppender.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.JdbcAppender.adoc
index 36e2e54..41c18db 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.JdbcAppender.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.db.jdbc.JdbcAppender.adoc
@@ -24,8 +24,8 @@ Provider:: `org.apache.logging.log4j:log4j-core`
This Appender writes logging events to a relational database using standard JDBC mechanisms.
-It takes a list of xref:ColumnConfig.adoc[]s and/or xref:ColumnMapping.adoc[]s with which it determines how to save the event data into the appropriate columns in the table.
-ColumnMapping is new as of Log4j 2.8 and supports xref:TypeConverter.adoc[] and persistence using xref:PreparedStatement.adoc[]. A xref:ConnectionSource.adoc[] plugin instance instructs the appender (and xref:JdbcDatabaseManager.adoc[]) how to connect to the database.
+It takes a list of apiref:ColumnConfig[]s and/or apiref:ColumnMapping[]s with which it determines how to save the event data into the appropriate columns in the table.
+ColumnMapping is new as of Log4j 2.8 and supports apiref:TypeConverter[] and persistence using apiref:PreparedStatement[]. A xref:ConnectionSource.adoc[] plugin instance instructs the appender (and xref:JdbcDatabaseManager.adoc[]) how to connect to the database.
This appender can be reconfigured at run time.
[#org_apache_logging_log4j_core_appender_db_jdbc_JdbcAppender-XML-snippet]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.nosql.NoSqlAppender.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.nosql.NoSqlAppender.adoc
index 9204813..a68218d 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.nosql.NoSqlAppender.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.nosql.NoSqlAppender.adoc
@@ -24,7 +24,7 @@ Provider:: `org.apache.logging.log4j:log4j-core`
This Appender writes logging events to a NoSQL database using a configured NoSQL provider.
-It requires implementations of xref:NoSqlObject.adoc[], xref:NoSqlConnection.adoc[], and xref:NoSqlProvider.adoc[] to "know" how to write events to the chosen NoSQL database.
+It requires implementations of apiref:NoSqlObject[], apiref:NoSqlConnection[], and xref:NoSqlProvider.adoc[] to "know" how to write events to the chosen NoSQL database.
For examples on how to write your own NoSQL provider, see the simple source code for the MongoDB and CouchDB providers.
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.AbstractTriggeringPolicy.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.AbstractTriggeringPolicy.adoc
index e4faa43..d6f5d91 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.AbstractTriggeringPolicy.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.AbstractTriggeringPolicy.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.appender.rolling.AbstractTriggeringPolicy
Provider:: `org.apache.logging.log4j:log4j-core`
-Abstract convenience class for triggering policies that extend xref:AbstractLifeCycle.adoc[] and implement xref:TriggeringPolicy.adoc[].
+Abstract convenience class for triggering policies that extend apiref:AbstractLifeCycle[] and implement apiref:TriggeringPolicy[].
[#org_apache_logging_log4j_core_appender_rolling_AbstractTriggeringPolicy-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.DeleteAction.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.DeleteAction.adoc
index ab18954..79f5090 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.DeleteAction.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.DeleteAction.adoc
@@ -89,7 +89,7 @@ a|an array of path conditions (if more than one, they all need to accept a path
|
|xref:../log4j-core/org.apache.logging.log4j.core.appender.rolling.action.PathSorter.adoc[PathSorter]?
-a|a plugin implementing the xref:PathSorter.adoc[] interface
+a|a plugin implementing the apiref:PathSorter[] interface
|ScriptCondition
|xref:../log4j-core/org.apache.logging.log4j.core.appender.rolling.action.ScriptCondition.adoc[ScriptCondition]?
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.IfFileName.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.IfFileName.adoc
index 0e52c34..c162ff7 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.IfFileName.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.IfFileName.adoc
@@ -26,8 +26,8 @@ PathCondition that accepts files for deletion if their relative path matches eit
If both a regular expression and a glob pattern are specified the glob pattern is used and the regular expression is ignored.
-The regular expression is a pattern as defined by the xref:Pattern.adoc[] class.
-A glob is a simplified pattern expression described in xref:FileSystem.adoc[].
+The regular expression is a pattern as defined by the apiref:Pattern[] class.
+A glob is a simplified pattern expression described in apiref:FileSystem[].
[#org_apache_logging_log4j_core_appender_rolling_action_IfFileName-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.PathSortByModificationTime.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.PathSortByModificationTime.adoc
index 28ca40d..31bcabe 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.PathSortByModificationTime.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.PathSortByModificationTime.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.appender.rolling.action.PathSortByModific
Provider:: `org.apache.logging.log4j:log4j-core`
-xref:PathSorter.adoc[] that sorts path by their LastModified attribute.
+apiref:PathSorter[] that sorts path by their LastModified attribute.
[#org_apache_logging_log4j_core_appender_rolling_action_PathSortByModificationTime-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.ScriptCondition.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.ScriptCondition.adoc
index ce55b84..367f7c6 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.ScriptCondition.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.appender.rolling.action.ScriptCondition.adoc
@@ -22,9 +22,9 @@ Class:: `org.apache.logging.log4j.core.appender.rolling.action.ScriptCondition`
Provider:: `org.apache.logging.log4j:log4j-core`
-A condition of the xref:DeleteAction.adoc[] where a user-provided script selects the files to delete from a provided list.
+A condition of the apiref:DeleteAction[] where a user-provided script selects the files to delete from a provided list.
-The specified script may be a xref:org.apache.logging.log4j.core.script.Script.adoc[Script], a xref:ScriptFile.adoc[] or a xref:ScriptRef.adoc[].
+The specified script may be a xref:org.apache.logging.log4j.core.script.Script.adoc[Script], a apiref:ScriptFile[] or a apiref:ScriptRef[].
[#org_apache_logging_log4j_core_appender_rolling_action_ScriptCondition-XML-snippet]
== XML snippet
@@ -45,15 +45,15 @@ Optional components are denoted by `?`-suffixed types.
|
|xref:../log4j-core/org.apache.logging.log4j.core.script.AbstractScript.adoc[AbstractScript]?
a|The script to run.
-This may be a xref:org.apache.logging.log4j.core.script.Script.adoc[Script], a xref:ScriptFile.adoc[] or a xref:ScriptRef.adoc[]. The script must return a `List<PathWithAttributes>`. When the script is executed, it is provided the following bindings:
+This may be a xref:org.apache.logging.log4j.core.script.Script.adoc[Script], a apiref:ScriptFile[] or a apiref:ScriptRef[]. The script must return a `List<PathWithAttributes>`. When the script is executed, it is provided the following bindings:
-* basePath - the directory from where the xref:DeleteAction.adoc[] action started scanning for files to delete.
+* basePath - the directory from where the apiref:DeleteAction[] action started scanning for files to delete.
Can be used to relativize the paths in the pathList.
* pathList - a `java. util. List` containing xref:org.apache.logging.log4j.core.appender.rolling.action.PathWithAttributes.adoc[PathWithAttributes] objects.
(The script is free to modify and return this list.
)
* substitutor - a xref:org.apache.logging.log4j.core.lookup.StrSubstitutor.adoc[StrSubstitutor] that can be used to look up variables embedded in the base dir or other properties
-* statusLogger - the xref:StatusLogger.adoc[] that can be used to log events during script execution
+* statusLogger - the apiref:StatusLogger[] that can be used to log events during script execution
* any properties declared in the configuration
|===
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.ArrayBlockingQueueFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.ArrayBlockingQueueFactory.adoc
index e5d3e26..c13a8db 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.ArrayBlockingQueueFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.ArrayBlockingQueueFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.async.ArrayBlockingQueueFactory`
Provider:: `org.apache.logging.log4j:log4j-core`
-Factory for creating instances of xref:ArrayBlockingQueue.adoc[].
+Factory for creating instances of apiref:ArrayBlockingQueue[].
[#org_apache_logging_log4j_core_async_ArrayBlockingQueueFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.BlockingQueueFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.BlockingQueueFactory.adoc
index cc322da..aebbf68 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.BlockingQueueFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.BlockingQueueFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.async.BlockingQueueFactory`
Provider:: `org.apache.logging.log4j:log4j-core`
-Factory for creating instances of xref:BlockingQueue.adoc[].
+Factory for creating instances of apiref:BlockingQueue[].
[#org_apache_logging_log4j_core_async_BlockingQueueFactory-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.DisruptorBlockingQueueFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.DisruptorBlockingQueueFactory.adoc
index d6d014a..7f819fa 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.DisruptorBlockingQueueFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.DisruptorBlockingQueueFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.async.DisruptorBlockingQueueFactory`
Provider:: `org.apache.logging.log4j:log4j-core`
-Factory for creating instances of xref:DisruptorBlockingQueue.adoc[].
+Factory for creating instances of apiref:DisruptorBlockingQueue[].
[#org_apache_logging_log4j_core_async_DisruptorBlockingQueueFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.JCToolsBlockingQueueFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.JCToolsBlockingQueueFactory.adoc
index b09532a..e1eeaad 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.JCToolsBlockingQueueFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.JCToolsBlockingQueueFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.async.JCToolsBlockingQueueFactory`
Provider:: `org.apache.logging.log4j:log4j-core`
-Factory for creating instances of BlockingQueues backed by JCTools xref:MpscArrayQueue.adoc[].
+Factory for creating instances of BlockingQueues backed by JCTools apiref:MpscArrayQueue[].
[#org_apache_logging_log4j_core_async_JCToolsBlockingQueueFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.LinkedTransferQueueFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.LinkedTransferQueueFactory.adoc
index a802edc..ae50464 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.LinkedTransferQueueFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.async.LinkedTransferQueueFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.async.LinkedTransferQueueFactory`
Provider:: `org.apache.logging.log4j:log4j-core`
-Factory for creating instances of xref:LinkedTransferQueue.adoc[].
+Factory for creating instances of apiref:LinkedTransferQueue[].
[#org_apache_logging_log4j_core_async_LinkedTransferQueueFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.ConfigurationFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.ConfigurationFactory.adoc
index e1f68ff..e25983b 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.ConfigurationFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.ConfigurationFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.ConfigurationFactory`
Provider:: `org.apache.logging.log4j:log4j-core`
-Factory class for parsed xref:Configuration.adoc[] objects from a configuration file.
+Factory class for parsed apiref:Configuration[] objects from a configuration file.
ConfigurationFactory allows the configuration implementation to be dynamically chosen in 1 of 3 ways:
@@ -31,7 +31,7 @@ configurationFactory" can be set with the name of the ConfigurationFactory to be
. xref:.adoc[] can be called with the instance of the ConfigurationFactory to be used.
This must be called before any other calls to Log4j.
. A ConfigurationFactory implementation can be added to the classpath and configured as a plugin in the xref:.adoc[] category.
-The xref:Order.adoc[] annotation should be used to configure the factory to be the first one inspected.
+The apiref:Order[] annotation should be used to configure the factory to be the first one inspected.
See xref:org.apache.logging.log4j.core.config.xml.XmlConfigurationFactory.adoc[XmlConfigurationFactory] for an example.
If the ConfigurationFactory that was added returns null on a call to getConfiguration then any other ConfigurationFactories found as plugins will be called in their respective order.
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BigDecimalConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BigDecimalConverter.adoc
index 326b714..db5a049 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BigDecimalConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BigDecimalConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Big
Provider:: `org.apache.logging.log4j:log4j-core`
-Parses a xref:String.adoc[] into a xref:BigDecimal.adoc[].
+Parses a apiref:String[] into a apiref:BigDecimal[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_BigDecimalConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BigIntegerConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BigIntegerConverter.adoc
index 053067c..007b0a5 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BigIntegerConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BigIntegerConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Big
Provider:: `org.apache.logging.log4j:log4j-core`
-Parses a xref:String.adoc[] into a xref:BigInteger.adoc[].
+Parses a apiref:String[] into a apiref:BigInteger[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_BigIntegerConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BooleanConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BooleanConverter.adoc
index 38c9ecd..bf75300 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BooleanConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.BooleanConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Boo
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Boolean.adoc[].
+Converts a apiref:String[] into a apiref:Boolean[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_BooleanConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteArrayConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteArrayConverter.adoc
index 7ced5fe..43fb701 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteArrayConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteArrayConverter.adoc
@@ -22,13 +22,13 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Byt
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a `byte[]`.
+Converts a apiref:String[] into a `byte[]`.
The supported formats are:
* 0x0123456789ABCDEF
* Base64:ABase64String
-* String using xref:Charset.adoc[] [TODO Should this be UTF-8 instead?
+* String using apiref:Charset[] [TODO Should this be UTF-8 instead?
]
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_ByteArrayConverter-XML-snippet]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteConverter.adoc
index d350041..60bddc9 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ByteConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Byt
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Byte.adoc[].
+Converts a apiref:String[] into a apiref:Byte[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_ByteConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharArrayConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharArrayConverter.adoc
index 521a937..4b171ac 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharArrayConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharArrayConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Cha
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a `char[]`.
+Converts a apiref:String[] into a `char[]`.
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_CharArrayConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharacterConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharacterConverter.adoc
index c6c7782..77a0f84 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharacterConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharacterConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Cha
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Character.adoc[].
+Converts a apiref:String[] into a apiref:Character[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_CharacterConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharsetConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharsetConverter.adoc
index e08a204..48ea956 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharsetConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.CharsetConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Cha
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Charset.adoc[].
+Converts a apiref:String[] into a apiref:Charset[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_CharsetConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ClassConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ClassConverter.adoc
index 5c8cfba..37eaa8e 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ClassConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ClassConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Cla
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Class.adoc[].
+Converts a apiref:String[] into a apiref:Class[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_ClassConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.DoubleConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.DoubleConverter.adoc
index 2ef7954..8831c83 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.DoubleConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.DoubleConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Dou
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Double.adoc[].
+Converts a apiref:String[] into a apiref:Double[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_DoubleConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.DurationConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.DurationConverter.adoc
index 9520969..4803f10 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.DurationConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.DurationConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Dur
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Duration.adoc[].
+Converts a apiref:String[] into a apiref:Duration[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_DurationConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FileConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FileConverter.adoc
index 56f4567..a8dcd4d 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FileConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FileConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Fil
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:File.adoc[].
+Converts a apiref:String[] into a apiref:File[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_FileConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FloatConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FloatConverter.adoc
index f4d0f4d..61165e2 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FloatConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.FloatConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Flo
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Float.adoc[].
+Converts a apiref:String[] into a apiref:Float[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_FloatConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.InetAddressConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.InetAddressConverter.adoc
index 31e1e61..b8f19f2 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.InetAddressConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.InetAddressConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Ine
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into an xref:InetAddress.adoc[].
+Converts a apiref:String[] into an apiref:InetAddress[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_InetAddressConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.IntegerConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.IntegerConverter.adoc
index 659ccb8..727b7f4 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.IntegerConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.IntegerConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Int
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Integer.adoc[].
+Converts a apiref:String[] into a apiref:Integer[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_IntegerConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.LevelConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.LevelConverter.adoc
index 02f73d2..d0a46bd 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.LevelConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.LevelConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Lev
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a Log4j xref:Level.adoc[].
+Converts a apiref:String[] into a Log4j apiref:Level[].
Returns `null` for invalid level names.
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.LongConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.LongConverter.adoc
index dd0d519..b21208c 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.LongConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.LongConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Lon
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Long.adoc[].
+Converts a apiref:String[] into a apiref:Long[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_LongConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PathConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PathConverter.adoc
index 71decd0..467cb3e 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PathConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PathConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Pat
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Path.adoc[].
+Converts a apiref:String[] into a apiref:Path[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_PathConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PatternConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PatternConverter.adoc
index 722c68a..be70cad 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PatternConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.PatternConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Pat
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Pattern.adoc[].
+Converts a apiref:String[] into a apiref:Pattern[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_PatternConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.SecurityProviderConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.SecurityProviderConverter.adoc
index 2d03b07..1510aee 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.SecurityProviderConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.SecurityProviderConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Sec
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Provider.adoc[].
+Converts a apiref:String[] into a apiref:Provider[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_SecurityProviderConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ShortConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ShortConverter.adoc
index 32c2389..e76ed48 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ShortConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.ShortConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Sho
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:Short.adoc[].
+Converts a apiref:String[] into a apiref:Short[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_ShortConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.StringConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.StringConverter.adoc
index 235e401..dee1e46 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.StringConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.StringConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Str
Provider:: `org.apache.logging.log4j:log4j-core`
-Returns the given xref:String.adoc[], no conversion takes place.
+Returns the given apiref:String[], no conversion takes place.
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_StringConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UriConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UriConverter.adoc
index f21f007..fbf152c 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UriConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UriConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Uri
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:URI.adoc[].
+Converts a apiref:String[] into a apiref:URI[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_UriConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UrlConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UrlConverter.adoc
index 7a4726e..654bdb5 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UrlConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UrlConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Url
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:URL.adoc[].
+Converts a apiref:String[] into a apiref:URL[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_UrlConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UuidConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UuidConverter.adoc
index bb633ae..1883037 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UuidConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.UuidConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.config.plugins.convert.TypeConverters.Uui
Provider:: `org.apache.logging.log4j:log4j-core`
-Converts a xref:String.adoc[] into a xref:UUID.adoc[].
+Converts a apiref:String[] into a apiref:UUID[].
[#org_apache_logging_log4j_core_config_plugins_convert_TypeConverters_UuidConverter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.DynamicThresholdFilter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.DynamicThresholdFilter.adoc
index fea90c1..bdb4dea 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.DynamicThresholdFilter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.DynamicThresholdFilter.adoc
@@ -24,7 +24,7 @@ Provider:: `org.apache.logging.log4j:log4j-core`
Compares against a log level that is associated with a context value.
-By default the context is the xref:ThreadContext.adoc[], but users may xref:ContextDataInjectorFactory.adoc[] a custom xref:ContextDataInjector.adoc[] which obtains context data from some other source.
+By default the context is the apiref:ThreadContext[], but users may apiref:ContextDataInjectorFactory[] a custom xref:ContextDataInjector.adoc[] which obtains context data from some other source.
[#org_apache_logging_log4j_core_filter_DynamicThresholdFilter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.Filterable.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.Filterable.adoc
index 2f13d69..0aa4ef6 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.Filterable.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.Filterable.adoc
@@ -24,7 +24,7 @@ Provider:: `org.apache.logging.log4j:log4j-core`
Interface implemented by Classes that allow filtering to occur.
-Extends xref:LifeCycle.adoc[] since filters have a life cycle.
+Extends apiref:LifeCycle[] since filters have a life cycle.
[#org_apache_logging_log4j_core_filter_Filterable-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.LevelRangeFilter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.LevelRangeFilter.adoc
index 14efaef..cef7256 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.LevelRangeFilter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.LevelRangeFilter.adoc
@@ -22,13 +22,13 @@ Class:: `org.apache.logging.log4j.core.filter.LevelRangeFilter`
Provider:: `org.apache.logging.log4j:log4j-core`
-This filter returns the xref:.adoc[] result if the level of the xref:LogEvent.adoc[] is in the range of the configured xref:.adoc[] and xref:.adoc[] values, otherwise it returns the xref:.adoc[] result.
+This filter returns the xref:.adoc[] result if the level of the apiref:LogEvent[] is in the range of the configured xref:.adoc[] and xref:.adoc[] values, otherwise it returns the xref:.adoc[] result.
-The default values for xref:.adoc[] and xref:.adoc[] are set to xref:Level.adoc[] and xref:Level.adoc[], respectively.
-The default values for xref:.adoc[] and xref:.adoc[] are set to xref:Result.adoc[] and xref:Result.adoc[], respectively.
+The default values for xref:.adoc[] and xref:.adoc[] are set to apiref:Level[] and apiref:Level[], respectively.
+The default values for xref:.adoc[] and xref:.adoc[] are set to apiref:Result[] and apiref:Result[], respectively.
-The levels get compared by their associated integral values; xref:Level.adoc[] has an integral value of 0, xref:Level.adoc[] 100, xref:Level.adoc[] 200, and so on.
-For example, if the filter is configured with xref:.adoc[] set to xref:Level.adoc[], the filter will return xref:.adoc[] result for xref:LogEvent.adoc[]s of level with higher integral values; xref:Level.adoc[], xref:Level.adoc[], etc.
+The levels get compared by their associated integral values; apiref:Level[] has an integral value of 0, apiref:Level[] 100, xref:Level.adoc[] 200, and so on.
+For example, if the filter is configured with xref:.adoc[] set to apiref:Level[], the filter will return xref:.adoc[] result for apiref:LogEvent[]s of level with higher integral values; xref:Level.adoc[], xref:Level.adoc[], etc.
[#org_apache_logging_log4j_core_filter_LevelRangeFilter-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.RegexFilter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.RegexFilter.adoc
index ff0497c..83e2571 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.RegexFilter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.filter.RegexFilter.adoc
@@ -82,6 +82,6 @@ Optional components are denoted by `?`-suffixed types.
|
|String?
-a|An array of Strings where each String is a xref:Pattern.adoc[] compilation flag.
+a|An array of Strings where each String is a apiref:Pattern[] compilation flag.
|===
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.MessageLayout.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.MessageLayout.adoc
index 727f774..1684d4b 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.MessageLayout.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.MessageLayout.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.layout.MessageLayout`
Provider:: `org.apache.logging.log4j:log4j-core`
-Formats a xref:LogEvent.adoc[] in its xref:Message.adoc[] form.
+Formats a apiref:LogEvent[] in its apiref:Message[] form.
Useful in combination with a JMS Appender to map a Log4j xref:org.apache.logging.log4j.message.MapMessage.adoc[MapMessage] or xref:org.apache.logging.log4j.message.StringMapMessage.adoc[StringMapMessage] to a JMS xref:javax.jms.MapMessage.adoc[MapMessage].
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.PatternLayout.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.PatternLayout.adoc
index 9c9f9e6..c7cd6f8 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.PatternLayout.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.PatternLayout.adoc
@@ -24,7 +24,7 @@ Provider:: `org.apache.logging.log4j:log4j-core`
A flexible layout configurable with pattern string.
-The goal of this class is to xref:org.apache.logging.log4j.core.Layout.adoc[Layout] a xref:LogEvent.adoc[] and return the results.
+The goal of this class is to xref:org.apache.logging.log4j.core.Layout.adoc[Layout] a apiref:LogEvent[] and return the results.
The format of the result depends on the _conversion pattern_.
The conversion pattern is closely related to the conversion pattern of the printf function in C. A conversion pattern is composed of literal text and format control expressions called _conversion specifiers_.
@@ -113,7 +113,7 @@ a|
|noConsoleNoAnsi
|boolean?
|
-a|If `"true"` (default is false) and xref:System.adoc[] is null, do not output ANSI escape codes
+a|If `"true"` (default is false) and apiref:System[] is null, do not output ANSI escape codes
|noConsoleNoAnsi
|boolean?
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.SerializedLayout.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.SerializedLayout.adoc
index f53e85b..c049d30 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.SerializedLayout.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.layout.SerializedLayout.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.layout.SerializedLayout`
Provider:: `org.apache.logging.log4j:log4j-core`
-Formats a xref:LogEvent.adoc[] in its Java serialized form.
+Formats a apiref:LogEvent[] in its Java serialized form.
[#org_apache_logging_log4j_core_layout_SerializedLayout-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.lookup.ContextMapLookup.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.lookup.ContextMapLookup.adoc
index 5be930c..1c3ef79 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.lookup.ContextMapLookup.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.lookup.ContextMapLookup.adoc
@@ -24,7 +24,7 @@ Provider:: `org.apache.logging.log4j:log4j-core`
Looks up keys from the context.
-By default this is the xref:ThreadContext.adoc[], but users may xref:ContextDataInjectorFactory.adoc[] a custom xref:ContextDataInjector.adoc[] which obtains context data from some other source.
+By default this is the apiref:ThreadContext[], but users may apiref:ContextDataInjectorFactory[] a custom xref:ContextDataInjector.adoc[] which obtains context data from some other source.
[#org_apache_logging_log4j_core_lookup_ContextMapLookup-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.net.SocketOptions.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.net.SocketOptions.adoc
index c5d6cad..0018572 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.net.SocketOptions.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.net.SocketOptions.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.net.SocketOptions`
Provider:: `org.apache.logging.log4j:log4j-core`
-Holds all socket options settable via xref:Socket.adoc[] methods.
+Holds all socket options settable via apiref:Socket[] methods.
[#org_apache_logging_log4j_core_net_SocketOptions-XML-snippet]
== XML snippet
@@ -54,72 +54,72 @@ Optional attributes are denoted by `?`-suffixed types.
|keepAlive
|Boolean?
|
-a|See xref:Socket.adoc[].
+a|See apiref:Socket[].
-See xref:Socket.adoc[].
+See apiref:Socket[].
|oobInline
|Boolean?
|
-a|See xref:Socket.adoc[].
+a|See apiref:Socket[].
-See xref:Socket.adoc[].
+See apiref:Socket[].
|receiveBufferSize
|Integer?
|
-a|See xref:Socket.adoc[].
+a|See apiref:Socket[].
-See xref:Socket.adoc[].
+See apiref:Socket[].
|reuseAddress
|Boolean?
|
-a|See xref:Socket.adoc[].
+a|See apiref:Socket[].
-See xref:Socket.adoc[].
+See apiref:Socket[].
|rfc1349TrafficClass
|xref:../log4j-core/org.apache.logging.log4j.core.net.Rfc1349TrafficClass.adoc[Rfc1349TrafficClass]?
|
-a|See xref:Socket.adoc[].
+a|See apiref:Socket[].
-See xref:Socket.adoc[].
+See apiref:Socket[].
|sendBufferSize
|Integer?
|
-a|See xref:Socket.adoc[].
+a|See apiref:Socket[].
-See xref:Socket.adoc[].
+See apiref:Socket[].
|soLinger
|Integer?
|
-a|See xref:Socket.adoc[].
+a|See apiref:Socket[].
-See xref:Socket.adoc[].
+See apiref:Socket[].
|soTimeout
|Integer?
|
-a|See xref:Socket.adoc[].
+a|See apiref:Socket[].
-See xref:Socket.adoc[].
+See apiref:Socket[].
|tcpNoDelay
|Boolean?
|
-a|See xref:Socket.adoc[].
+a|See apiref:Socket[].
-See xref:Socket.adoc[].
+See apiref:Socket[].
|trafficClass
|Integer?
|
-a|See xref:Socket.adoc[].
+a|See apiref:Socket[].
-See xref:Socket.adoc[].
+See apiref:Socket[].
|===
@@ -134,8 +134,8 @@ Optional components are denoted by `?`-suffixed types.
|SocketPerformancePreferences
|xref:../log4j-core/org.apache.logging.log4j.core.net.SocketPerformancePreferences.adoc[SocketPerformancePreferences]?
-a|See xref:Socket.adoc[].
+a|See apiref:Socket[].
-See xref:Socket.adoc[].
+See apiref:Socket[].
|===
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.net.SocketPerformancePreferences.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.net.SocketPerformancePreferences.adoc
index 26ad428..32b3859 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.net.SocketPerformancePreferences.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.net.SocketPerformancePreferences.adoc
@@ -22,9 +22,9 @@ Class:: `org.apache.logging.log4j.core.net.SocketPerformancePreferences`
Provider:: `org.apache.logging.log4j:log4j-core`
-Holds all socket options settable via xref:Socket.adoc[].
+Holds all socket options settable via apiref:Socket[].
-The xref:Socket.adoc[] API may not be implemented by a JRE.
+The apiref:Socket[] API may not be implemented by a JRE.
[#org_apache_logging_log4j_core_net_SocketPerformancePreferences-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.ArrayPatternConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.ArrayPatternConverter.adoc
index 2e6ecf7..d478689 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.ArrayPatternConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.ArrayPatternConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.pattern.ArrayPatternConverter`
Provider:: `org.apache.logging.log4j:log4j-core`
-xref:PatternConverter.adoc[]s implement this interface to accept an array of objects when formatting.
+apiref:PatternConverter[]s implement this interface to accept an array of objects when formatting.
[#org_apache_logging_log4j_core_pattern_ArrayPatternConverter-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.FileDatePatternConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.FileDatePatternConverter.adoc
index 32fd333..8e553bc 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.FileDatePatternConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.FileDatePatternConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.core.pattern.FileDatePatternConverter`
Provider:: `org.apache.logging.log4j:log4j-core`
-Formats a date by delegating to xref:DatePatternConverter.adoc[].
+Formats a date by delegating to apiref:DatePatternConverter[].
The default date pattern for a %d specifier in a file name is different than the %d pattern in pattern layout.
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.HighlightConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.HighlightConverter.adoc
index 05f3def..6f7078d 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.HighlightConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-core/org.apache.logging.log4j.core.pattern.HighlightConverter.adoc
@@ -55,7 +55,7 @@ The available predefined styles are:
* `Logback`
You can use whitespace around the comma and equal sign.
-The names in values MUST come from the xref:AnsiEscape.adoc[] enum, case is normalized to upper-case internally.
+The names in values MUST come from the apiref:AnsiEscape[] enum, case is normalized to upper-case internally.
To disable ANSI output unconditionally, specify an additional option `disableAnsi=true`, or to disable ANSI output if no console is detected, specify option `noConsoleNoAnsi=true` e.g..
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.CaseConverterResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.CaseConverterResolverFactory.adoc
index c446e2b..47b15cc 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.CaseConverterResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.CaseConverterResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.CaseConverterRes
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:CaseConverterResolver.adoc[] factory.
+apiref:CaseConverterResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_CaseConverterResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.CounterResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.CounterResolverFactory.adoc
index 759551d..4ccb304 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.CounterResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.CounterResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.CounterResolverF
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:CounterResolver.adoc[] factory.
+apiref:CounterResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_CounterResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EndOfBatchResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EndOfBatchResolverFactory.adoc
index 89725aa..7445c99 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EndOfBatchResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EndOfBatchResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.EndOfBatchResolv
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:EndOfBatchResolver.adoc[] factory.
+apiref:EndOfBatchResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_EndOfBatchResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventAdditionalFieldInterceptor.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventAdditionalFieldInterceptor.adoc
index 3d79bfd..ac8e97f 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventAdditionalFieldInterceptor.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventAdditionalFieldInterceptor.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.EventAdditionalF
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-Interceptor to add xref:EventTemplateAdditionalField.adoc[] after event template read.
+Interceptor to add apiref:EventTemplateAdditionalField[] after event template read.
[#org_apache_logging_log4j_layout_template_json_resolver_EventAdditionalFieldInterceptor-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory.adoc
index 5e2caa7..467b77a 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.EventResolverFac
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:TemplateResolverFactory.adoc[] specialized for xref:LogEvent.adoc[]s.
+apiref:TemplateResolverFactory[] specialized for apiref:LogEvent[]s.
[#org_apache_logging_log4j_layout_template_json_resolver_EventResolverFactory-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventResolverInterceptor.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventResolverInterceptor.adoc
index b063343..c10af25 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventResolverInterceptor.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.EventResolverInterceptor.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.EventResolverInt
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:TemplateResolverInterceptor.adoc[] specialized for xref:LogEvent.adoc[]s.
+apiref:TemplateResolverInterceptor[] specialized for apiref:LogEvent[]s.
[#org_apache_logging_log4j_layout_template_json_resolver_EventResolverInterceptor-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ExceptionResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ExceptionResolverFactory.adoc
index ed0564b..44c2312 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ExceptionResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ExceptionResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.ExceptionResolve
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:ExceptionResolver.adoc[] factory.
+apiref:ExceptionResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_ExceptionResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ExceptionRootCauseResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ExceptionRootCauseResolverFactory.adoc
index d5d09b3..14455df 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ExceptionRootCauseResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ExceptionRootCauseResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.ExceptionRootCau
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:ExceptionRootCauseResolver.adoc[] factory.
+apiref:ExceptionRootCauseResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_ExceptionRootCauseResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.LevelResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.LevelResolverFactory.adoc
index 6efbd7b..100f727 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.LevelResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.LevelResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.LevelResolverFac
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:LevelResolver.adoc[] factory.
+apiref:LevelResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_LevelResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.LoggerResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.LoggerResolverFactory.adoc
index a363582..2038543 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.LoggerResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.LoggerResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.LoggerResolverFa
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:LoggerResolver.adoc[] factory.
+apiref:LoggerResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_LoggerResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MainMapResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MainMapResolverFactory.adoc
index 1908679..0c4d4af 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MainMapResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MainMapResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.MainMapResolverF
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:MainMapResolver.adoc[] factory.
+apiref:MainMapResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_MainMapResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MapResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MapResolverFactory.adoc
index bb100f4..9de3662 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MapResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MapResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.MapResolverFacto
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:MapResolver.adoc[] factory.
+apiref:MapResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_MapResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MarkerResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MarkerResolverFactory.adoc
index de9ddd4..c330a50 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MarkerResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MarkerResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.MarkerResolverFa
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:MarkerResolver.adoc[] factory.
+apiref:MarkerResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_MarkerResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MessageParameterResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MessageParameterResolverFactory.adoc
index 272b4f2..a0126ea 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MessageParameterResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MessageParameterResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.MessageParameter
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:MessageParameterResolver.adoc[] factory.
+apiref:MessageParameterResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_MessageParameterResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MessageResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MessageResolverFactory.adoc
index 9b0d37e..48b027a 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MessageResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.MessageResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.MessageResolverF
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-A xref:MessageResolver.adoc[] factory.
+A apiref:MessageResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_MessageResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.PatternResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.PatternResolverFactory.adoc
index 8d1a6eb..b64cb8d 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.PatternResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.PatternResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.PatternResolverF
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:PatternResolver.adoc[] factory.
+apiref:PatternResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_PatternResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.SourceResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.SourceResolverFactory.adoc
index 92bcad5..d3cff6d 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.SourceResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.SourceResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.SourceResolverFa
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:SourceResolver.adoc[] factory.
+apiref:SourceResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_SourceResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory.adoc
index 9f73320..b00e8c9 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.TemplateResolver
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:TemplateResolver.adoc[] factory.
+apiref:TemplateResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_TemplateResolverFactory-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverInterceptor.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverInterceptor.adoc
index 4ddd932..93ec7e6 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverInterceptor.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TemplateResolverInterceptor.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.TemplateResolver
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-Main xref:TemplateResolver.adoc[] compilation interception interface.
+Main apiref:TemplateResolver[] compilation interception interface.
[#org_apache_logging_log4j_layout_template_json_resolver_TemplateResolverInterceptor-implementations]
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadContextDataResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadContextDataResolverFactory.adoc
index f9ad078..6e86d1c 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadContextDataResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadContextDataResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.ThreadContextDat
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:ThreadContextDataResolver.adoc[] factory.
+apiref:ThreadContextDataResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_ThreadContextDataResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadContextStackResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadContextStackResolverFactory.adoc
index e3069cc..11f1fb5 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadContextStackResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadContextStackResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.ThreadContextSta
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:ThreadContextStackResolver.adoc[] factory.
+apiref:ThreadContextStackResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_ThreadContextStackResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadResolverFactory.adoc
index bcd5824..0baed28 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.ThreadResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.ThreadResolverFa
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:ThreadResolver.adoc[] factory.
+apiref:ThreadResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_ThreadResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TimestampResolverFactory.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TimestampResolverFactory.adoc
index a0b4d06..9e6a55f 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TimestampResolverFactory.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.resolver.TimestampResolverFactory.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.resolver.TimestampResolve
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-xref:TimestampResolver.adoc[] factory.
+apiref:TimestampResolver[] factory.
[#org_apache_logging_log4j_layout_template_json_resolver_TimestampResolverFactory-XML-snippet]
== XML snippet
diff --git a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.util.RecyclerFactoryConverter.adoc b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.util.RecyclerFactoryConverter.adoc
index e2c3932..6da6faf 100644
--- a/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.util.RecyclerFactoryConverter.adoc
+++ b/log4j-docgen/src/test/resources/DocumentationGeneratorTest/complex/freemarker-output/log4j-layout-template-json/org.apache.logging.log4j.layout.template.json.util.RecyclerFactoryConverter.adoc
@@ -22,7 +22,7 @@ Class:: `org.apache.logging.log4j.layout.template.json.util.RecyclerFactoryConve
Provider:: `org.apache.logging.log4j:log4j-layout-template-json`
-The default string (i.e., recycler factory spec) to xref:RecyclerFactory.adoc[] type converter.
+The default string (i.e., recycler factory spec) to apiref:RecyclerFactory[] type converter.
[#org_apache_logging_log4j_layout_template_json_util_RecyclerFactoryConverter-XML-snippet]
== XML snippet