Skip to content

2.x: Odd JavaDoc formatting #6004

@akarnokd

Description

@akarnokd

Since we switched to Java 8 compilation, the generated JavaDocs often lists method arguments misaligned, for example:

http://reactivex.io/RxJava/2.x/javadoc/snapshot/io/reactivex/flowables/ConnectableFlowable.html#refCount-long-java.util.concurrent.TimeUnit-

image

Looks like the whole section is put into <pre> so those extra spaces break the layout:

<pre><a href="../../../io/reactivex/annotations/CheckReturnValue.html" title="annotation in io.reactivex.annotations">@CheckReturnValue</a>
 <a href="../../../io/reactivex/annotations/SchedulerSupport.html" title="annotation in io.reactivex.annotations">@SchedulerSupport</a>(<a href="../../../io/reactivex/annotations/SchedulerSupport.html#value--">value</a>="io.reactivex:computation")
 <a href="../../../io/reactivex/annotations/BackpressureSupport.html" title="annotation in io.reactivex.annotations">@BackpressureSupport</a>(<a href="../../../io/reactivex/annotations/BackpressureSupport.html#value--">value</a>=<a href="../../../io/reactivex/annotations/BackpressureKind.html#PASS_THROUGH">PASS_THROUGH</a>)
public final&nbsp;<a href="../../../io/reactivex/Flowable.html" title="class in io.reactivex">Flowable</a>&lt;<a href="../../../io/reactivex/flowables/ConnectableFlowable.html" title="type parameter in ConnectableFlowable">T</a>&gt;&nbsp;refCount(long&nbsp;timeout,
                                                                                                                                                   <a href="https://docs.oracle.com/javase/7/docs/api/java/util/concurrent/TimeUnit.html?is-external=true" title="class or interface in java.util.concurrent">TimeUnit</a>&nbsp;unit)</pre>

I wonder if it would be possible to avoid those.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions