[jira] [Commented] (RNG-141) Cross-reference links not found (web site)

["Alex Herbert (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/RNG-141?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17606734#comment-17606734 ] 

Alex Herbert commented on RNG-141:
----------------------------------

Note that the provided xref link is for the top level parent module:

[https://commons.apache.org/proper/commons-rng/xref/]

If a module is inserted after {{commons-rng}} then the cross referencing works as expected (for public classes that have a javadoc):

[https://commons.apache.org/proper/commons-rng/commons-rng-core/xref/]

This is because each module has its own xref and javadoc.

However although the parent module has xref there is no aggregate javadoc. RNG has a special module (docs-archive) to create aggregate javadoc as this must be performed from a module that depends on all other modules that are to be included in the javadoc report. This cannot be done for the top level parent module. Currently the aggregate report is for the main modules and does not include the examples. This module is not used in release process.

One fix would be to use the docs-archive module to generate aggregate javadoc and copy it to the require location in the site. A javadoc link can be added to the top level site menu for ease of browsing the API. This could be updated to support the examples modules as well.

> Cross-reference links not found (web site)
> ------------------------------------------
>
>                 Key: RNG-141
>                 URL: https://issues.apache.org/jira/browse/RNG-141
>             Project: Commons RNG
>          Issue Type: Bug
>            Reporter: Gilles Sadowski
>            Priority: Minor
>              Labels: cross-reference, javadoc, link, web-site
>
> At the top of pages generated by the cross-referencing tool (e.g. [this one|http://commons.apache.org/proper/commons-rng/xref/org/apache/commons/rng/examples/sampling/ExamplesSamplingApplication.html]), there is a link named [View Javadoc|http://commons.apache.org/proper/commons-rng/apidocs/org/apache/commons/rng/examples/sampling/ExamplesSamplingApplication.html] which when clicked on leads to "Not Found".
> The issue seems to occur in a multi-module project (also in [Geometry] and [Numbers]) because when starting from [this page|http://commons.apache.org/proper/commons-rng/apidocs/org/apache/commons/rng/examples/sampling/ExamplesSamplingApplication.html], the link works.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)