You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@camel.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2019/09/03 20:42:00 UTC
[jira] [Work logged] (CAMEL-13920) Find a way to propagate base
markup syntax from javadoc to website
[ https://issues.apache.org/jira/browse/CAMEL-13920?focusedWorklogId=305870&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-305870 ]
ASF GitHub Bot logged work on CAMEL-13920:
------------------------------------------
Author: ASF GitHub Bot
Created on: 03/Sep/19 20:41
Start Date: 03/Sep/19 20:41
Worklog Time Spent: 10m
Work Description: bedlaj commented on pull request #3137: CAMEL-13920: Allow using markup in option description
URL: https://github.com/apache/camel/pull/3137
This is best way, I have found so far to allow lists in description. Please review and comment, if you see some better solution, because I feel, that adding `\n` to javadoc is somehow incorrect.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 305870)
Remaining Estimate: 0h
Time Spent: 10m
> 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
> Assignee: Jan Bednar
> Priority: Minor
> Time Spent: 10m
> Remaining Estimate: 0h
>
> 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)