Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add xref support for adoc file sourced from javadoc #2417

Closed
aldettinger opened this issue Mar 30, 2021 · 0 comments · Fixed by #2420
Closed

docs: add xref support for adoc file sourced from javadoc #2417

aldettinger opened this issue Mar 30, 2021 · 0 comments · Fixed by #2420
Milestone

Comments

@aldettinger
Copy link
Contributor

More context with this commit.

With a @configitem as below:

/**
     * If {@code true} all {@code camel-main} features are enabled; otherwise no {@code camel-main} features are
     * enabled. See described the
     * <a href="https://camel.apache.org/camel-quarkus/latest/user-guide/bootstrap.html#_camel_main">Bootstrap</a>
     * section of Camel Quarkus documentation for more details.
     */
    @ConfigItem(defaultValue = "true")
    public boolean enabled;

The generated adoc documentation in docs/modules/ROOT/pages/reference/extensions/core.adoc will contain:

link:https://camel.apache.org/camel-quarkus/latest/user-guide/bootstrap.html#_camel_main[Bootstrap]

while an xref as below is expected:

xref:user-guide/bootstrap.adoc[Bootstrap].
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants