[
https://issues.apache.org/jira/browse/CAMEL-13920?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16920467#comment-16920467
]
Jan Bednar edited comment on CAMEL-13920 at 9/1/19 5:47 PM:
------------------------------------------------------------
This can be hacked by explicitly adding *\n* on relevant lines in javadoc. Then
are line endings propagated throught json model to website. But I am not sure
how well this will be handled by other dependent tools and how this will look
like on javadoc.io
Also if we find OK to include *\n* in javadoc, then we need to make adoc
generator a bit smarter, to prefix table cell with *a|* , if description
contains markdown tags. Without this prefix is content of cell interpreted as
plain text.
was (Author: bedla):
This can be hacked by explicitly adding *\n* on relevant lines in javadoc. Then
are line endings propagated throught json model to website. But I am not sure
how well this will be handled by other dependent tools and how this will look
like on javadoc.io
Also if we find OK to include *\n* in javadoc, then we need to make adoc
generator i bit smarter, to prefix table cell with *a|* , if description
contains markdown tags. Without it is content of cell interpreted as plain text.
> Find a way to propagate base markup syntax from javadoc to website
> ------------------------------------------------------------------
>
> Key: CAMEL-13920
> URL: https://issues.apache.org/jira/browse/CAMEL-13920
> Project: Camel
> Issue Type: Improvement
> Components: documentation
> Reporter: Jan Bednar
> Priority: Minor
>
> HTML tags seems to be stripped out when creating json schema from javadoc.
> Can we include some of safe tags, or replace them with markup, or find some
> other way to propagate formating from javadoc to website?
> This can be seen specialy in [file
> component|https://camel.apache.org/components/latest/file-component.html] for
> readLock option.
> [Javadoc|https://github.com/apache/camel/blob/master/components/camel-file/src/main/java/org/apache/camel/component/file/GenericFileEndpoint.java#L842]
> for this option contains nice <li> list of allowed values, but on website
> (and also in file.json) are tags excluded. This tends to description, which
> is really hard to read on website.
--
This message was sent by Atlassian Jira
(v8.3.2#803003)
