camel-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Antonin Stefanutti (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CAMEL-9541) Component docs - Maintain docs as part of the source code
Date Tue, 16 Feb 2016 13:06:18 GMT

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

Antonin Stefanutti commented on CAMEL-9541:
-------------------------------------------

We should have the ability to style the description: for example code literal from the Javadoc
would render as an inline code block in the description column.

Another point would be to migrate the existing examples Markdown to Asciidoc and have them
included into the generated gitbook.

> Component docs - Maintain docs as part of the source code
> ---------------------------------------------------------
>
>                 Key: CAMEL-9541
>                 URL: https://issues.apache.org/jira/browse/CAMEL-9541
>             Project: Camel
>          Issue Type: New Feature
>          Components: build system, documentation
>            Reporter: Claus Ibsen
>
> Just a ticket to capture what we are discussing at @dev
> http://camel.465427.n5.nabble.com/gitbook-based-doc-generation-td5776497.html
> We have a maven plugin that can keep all the component and endpoint options up to date.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message