[CAMEL-12743] Some @link javadoc notations not handled well in auto-generated adocs

• Type: Task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.22.0
• Fix Version/s: 2.23.0
• Component/s: documentation
• Estimated Complexity: Unknown
• Assignee: Claus Ibsen
• Reporter: Tadayoshi Sato
• Created: 21/Aug/18 08:25
• Updated: 22/Aug/18 10:24
• Resolved: 22/Aug/18 10:24

Description

For example, this javadoc:
https://github.com/apache/camel/blob/master/camel-core/src/main/java/org/apache/camel/model/SplitDefinition.java#L257-L271

    /**
     * When in streaming mode, then the splitter splits the original message on-demand, and each splitted
     * message is processed one by one. This reduces memory usage as the splitter do not split all the messages first,
     * but then we do not know the total size, and therefore the {@link org.apache.camel.Exchange#SPLIT_SIZE} is empty.
     * <p/>
     * In non-streaming mode (default) the splitter will split each message first, to know the total size, and then
     * process each message one by one. This requires to keep all the splitted messages in memory and therefore requires
     * more memory. The total size is provided in the {@link org.apache.camel.Exchange#SPLIT_SIZE} header.
     * <p/>
     * The streaming mode also affects the aggregation behavior.
     * If enabled then Camel will process replies out-of-order, eg in the order they come back.
     * If disabled, Camel will process replies in the same order as the messages was splitted.
     *
     * @return the builder
     */

is generated to:
https://github.com/apache/camel/blob/master/camel-core/src/main/docs/eips/split-eip.adoc

When in streaming mode, then the splitter splits the original message on-demand, and each splitted message is processed one by one. This reduces memory usage as the splitter do not split all the messages first, but then we do not know the total size, and therefore the *link* org.apache.camel.ExchangeSPLIT_SIZE is empty. In non-streaming mode (default) the splitter will split each message first, to know the total size, and then process each message one by one. This requires to keep all the splitted messages in memory and therefore requires more memory. The total size is provided in the *link* org.apache.camel.ExchangeSPLIT_SIZE header. The streaming mode also affects the aggregation behavior. If enabled then Camel will process replies out-of-order, eg in the order they come back. If disabled, Camel will process replies in the same order as the messages was splitted.

It is my impression that the current doc generator handles only FQCN well but fails to handle all other forms of Java source references.