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-11021) Missing javadoc on rest-dsl model
Date Fri, 07 Apr 2017 08:16:41 GMT

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

Claus Ibsen commented on CAMEL-11021:
-------------------------------------

{code}
[WARNING] 	Missing javadoc on models: 10
[WARNING] 		delete
[WARNING] 		get
[WARNING] 		head
[WARNING] 		options
[WARNING] 		patch
[WARNING] 		post
[WARNING] 		put
[WARNING] 		restBinding
[WARNING] 		verb
[WARNING] 		camelContext
{code}

And more details here
{code}
[INFO] Found 222 models to use when enriching the XSD schema
[WARNING] Cannot find documentation for name: method in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
[WARNING] Cannot find documentation for name: uri in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
[WARNING] Cannot find documentation for name: consumes in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
[WARNING] Cannot find documentation for name: produces in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
[WARNING] Cannot find documentation for name: bindingMode in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
[WARNING] Cannot find documentation for name: skipBindingOnErrorCode in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
[WARNING] Cannot find documentation for name: enableCORS in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
[WARNING] Cannot find documentation for name: routeId in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
[WARNING] Cannot find documentation for name: apiDocs in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
[WARNING] Cannot find documentation for name: consumes in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
[WARNING] Cannot find documentation for name: produces in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
[WARNING] Cannot find documentation for name: bindingMode in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
[WARNING] Cannot find documentation for name: skipBindingOnErrorCode in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
[WARNING] Cannot find documentation for name: enableCORS in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
[WARNING] Cannot find documentation for name: component in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
[WARNING] Cannot find documentation for name: logMask in json schema: /Users/davsclaus/workspace/camel/components/camel-spring/target/../../../camel-core/target/classes/org/apache/camel/model/route.json
{code}

> Missing javadoc on rest-dsl model
> ---------------------------------
>
>                 Key: CAMEL-11021
>                 URL: https://issues.apache.org/jira/browse/CAMEL-11021
>             Project: Camel
>          Issue Type: Task
>          Components: camel-core
>    Affects Versions: 2.19.0
>            Reporter: Claus Ibsen
>             Fix For: 2.19.0
>
>
> We get a warning such as
> {code}
> [INFO] --- camel-eip-documentation-enricher-maven-plugin:2.19.0-SNAPSHOT:eip-documentation-enricher
(eip-documentation-enricher) @ camel-blueprint ---
> [INFO] Found 221 models to use when enriching the XSD schema
> [WARNING] Cannot find documentation for name: method in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
> [WARNING] Cannot find documentation for name: uri in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
> [WARNING] Cannot find documentation for name: consumes in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
> [WARNING] Cannot find documentation for name: produces in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
> [WARNING] Cannot find documentation for name: bindingMode in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
> [WARNING] Cannot find documentation for name: skipBindingOnErrorCode in json schema:
/Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
> [WARNING] Cannot find documentation for name: enableCORS in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
> [WARNING] Cannot find documentation for name: routeId in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
> [WARNING] Cannot find documentation for name: apiDocs in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
> [WARNING] Cannot find documentation for name: consumes in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
> [WARNING] Cannot find documentation for name: produces in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
> [WARNING] Cannot find documentation for name: bindingMode in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
> [WARNING] Cannot find documentation for name: skipBindingOnErrorCode in json schema:
/Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
> [WARNING] Cannot find documentation for name: enableCORS in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
> [WARNING] Cannot find documentation for name: component in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
> {code}
> The same would building platforms/camel-catalog warn about later on.
> We need to ensure the model is fully documented before a release



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Mime
View raw message