apache / apache/logging-log4j-tools

`log4j-docgen` cannot convert method references with multiple arguments in Javadoc to AsciiDoc

Open
#110 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Java
Stars
18
Forks
19
PR merge metrics
No merged PRs in 30d

Description

The following Javadoc copied from `org.apache.logging.log4j.core.filter.AbstractFilter`
```
Garbage-free note: the methods with unrolled varargs by default delegate to the
{@link #filter(Logger, Level, Marker, String, Object...) filter method with vararg parameters}.
Subclasses that want to be garbage-free should override these methods to implement the appropriate filtering
without creating a vararg array.
```
gets converted to
```
Garbage-free note: the methods with unrolled varargs by default delegate to the apiref:org.apache.logging.log4j.core.filter.AbstractFilter#filter(Logger, Level, Marker, String, Object...)[filter method with vararg parameters].
```
This AsciiDoc is invalid due to the whitespace in between method arguments. As a result, AsciiDoctor doesn't even recognize the `apiref:...` snippet as an inline macro, and consequently, don't call `ApirefMacro`.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.