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-8023) Add javadoc documentation to camel-core endpoints so we have documentation out of the box
Date Fri, 06 Feb 2015 09:21:34 GMT

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

Claus Ibsen commented on CAMEL-8023:
------------------------------------

PS to see which options is missing, then check the generated .json schema file in the JAR,
eg in camel-core, each component has such a file. You can also quickly see them in the target/classes
directory.

So for bean component we have
{code}
 "properties": {
    "beanName": { "kind": "path", "type": "string", "javaType": "java.lang.String", "deprecated":
"false", "description": "Sets the name of the bean to invoke" },
    "cache": { "kind": "parameter", "type": "boolean", "javaType": "boolean", "deprecated":
"false", "defaultValue": "false" },
    "multiParameterArray": { "kind": "parameter", "type": "boolean", "javaType": "boolean",
"deprecated": "false", "defaultValue": "false" },
    "method": { "kind": "parameter", "type": "string", "javaType": "java.lang.String", "deprecated":
"false", "description": "Sets the name of the method to invoke on the bean" },
    "exchangePattern": { "kind": "parameter", "type": "string", "javaType": "org.apache.camel.ExchangePattern",
"enum": [ "InOnly", "RobustInOnly", "InOut", "InOptionalOut", "OutOnly", "RobustOutOnly",
"OutIn", "OutOptionalIn" ], "deprecated": "false", "defaultValue": "InOnly", "description":
"Sets the default exchange pattern when creating an exchange." },
    "synchronous": { "kind": "parameter", "type": "boolean", "javaType": "boolean", "deprecated":
"false", "defaultValue": "false", "description": "Sets whether synchronous processing should
be strictly used or Camel is allowed to use asynchronous processing (if supported)." }
  }
{code}

So cache and multiParameterArray have no documentation.

> Add javadoc documentation to camel-core endpoints so we have documentation out of the
box
> -----------------------------------------------------------------------------------------
>
>                 Key: CAMEL-8023
>                 URL: https://issues.apache.org/jira/browse/CAMEL-8023
>             Project: Camel
>          Issue Type: Sub-task
>          Components: camel-core
>            Reporter: Claus Ibsen
>            Assignee: Willem Jiang
>             Fix For: 2.15.0
>
>
> See parent ticket.
> For each of the components in camel-core, we need to document each @UriParam option.
This is done by adding javadoc to the setter method.



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

Mime
View raw message