camel-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Claus Ibsen (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CAMEL-9541) Component docs - Maintain docs as part of the source code
Date Wed, 17 Aug 2016 11:41:20 GMT

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

Claus Ibsen commented on CAMEL-9541:
------------------------------------

When building camel-catalog it now reports missing adoc documentation

{code}
[INFO] ================================================================================
[INFO]
[INFO] Camel missing documents report
[INFO]
[INFO]
[WARNING]      	Missing .adoc component documentation  : 4
[WARNING]      		ftps-component
[WARNING]      		linkedin-component
[WARNING]      		salesforce-component
[WARNING]      		sftp-component
[INFO]
[WARNING]      	Missing .adoc dataformat documentation  : 19
[WARNING]      		avro-dataformat
[WARNING]      		barcode-dataformat
[WARNING]      		bindy-csv-dataformat
[WARNING]      		bindy-fixed-dataformat
[WARNING]      		bindy-kvp-dataformat
[WARNING]      		crypto-dataformat
[WARNING]      		gzip-dataformat
[WARNING]      		json-xstream-dataformat
[WARNING]      		mime-multipart-dataformat
[WARNING]      		pgp-dataformat
[WARNING]      		rss-dataformat
[WARNING]      		secureXML-dataformat
[WARNING]      		serialization-dataformat
[WARNING]      		string-dataformat
[WARNING]      		univocity-csv-dataformat
[WARNING]      		univocity-fixed-dataformat
[WARNING]      		univocity-tsv-dataformat
[WARNING]      		xmlrpc-dataformat
[WARNING]      		zip-dataformat
[INFO]
[WARNING]      	Missing .adoc language documentation  : 16
[WARNING]      		exchangeProperty-language
[WARNING]      		file-language
[WARNING]      		header-language
[WARNING]      		javaScript-language
[WARNING]      		mvel-language
[WARNING]      		php-language
[WARNING]      		python-language
[WARNING]      		ref-language
[WARNING]      		ruby-language
[WARNING]      		simple-language
[WARNING]      		spel-language
[WARNING]      		terser-language
[WARNING]      		tokenize-language
[WARNING]      		xpath-language
[WARNING]      		xquery-language
[WARNING]      		xtokenize-language
{code}

> 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
>            Assignee: Andrea Cosentino
>             Fix For: 2.18.0
>
>
> 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