[jira] [Commented] (CAMEL-15474) camel-api-component - Source code generator should include parameter documentation

["Claus Ibsen (Jira)" <ji...@apache.org>]

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

Claus Ibsen commented on CAMEL-15474:
-------------------------------------

Unfortunately the api parser was written a long time ago with a mix of regexp and html javadoc parsing via stax so its a bit messy.

Would been nicer to use javapoet or roaster to just parse the source code more reliablly.
But the old code is being enhanced to incl parameter docs via the javadoc.

Got some more details now for those big api components we didnt have before. But need to fiddle to make the javadoc parsing more robust as the javadoc has messy html text that barfs the parser.

> camel-api-component - Source code generator should include parameter documentation
> ----------------------------------------------------------------------------------
>
>                 Key: CAMEL-15474
>                 URL: https://issues.apache.org/jira/browse/CAMEL-15474
>             Project: Camel
>          Issue Type: Improvement
>          Components: tooling
>            Reporter: Claus Ibsen
>            Assignee: Claus Ibsen
>            Priority: Major
>             Fix For: 3.5.0
>
>
> api components are generated from some existing Java library via a maven plugin that generate source code and grabs method signatures from javadoc.
> We should include parameter description for these method signatures so we have documentation for them too.
> Currently we generate empty POJO classes for these method signatures.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)