camel-users mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stefan Ziegler <stefan.ziegler...@gmail.com>
Subject Re: Automatic documentation of a component
Date Wed, 06 Mar 2019 17:11:34 GMT
Does the code has to be in the "org.apache.camel.component" package? Or can
it be anything?

Stefan

On Wed, Mar 6, 2019 at 3:52 PM Claus Ibsen <claus.ibsen@gmail.com> wrote:

> Hi
>
> Yeah the adoc file should be in src/main/docs and be named
>
> componentName-component.adoc
>
> so if the component is named acme, then it should be
>
> acme-component.adoc
>
>
> On Wed, Mar 6, 2019 at 2:58 PM Stefan Ziegler
> <stefan.ziegler.de@gmail.com> wrote:
> >
> > Hi
> >
> > I used the maven archetype so I think it should be all there.
> >
> > Which names have to match? The name of the .adoc file must be identical
> to
> > ...?
> >
> > regards
> > Stefan
> >
> > On Wed, Mar 6, 2019 at 12:48 PM Claus Ibsen <claus.ibsen@gmail.com>
> wrote:
> >
> > > Hi
> > >
> > > You need to have a maven plugin added and another dependency.
> > >
> > > See this pom
> > >
> > >
> https://github.com/apache/camel/blob/camel-2.x/connectors/examples/beverage-component/pom.xml
> > >
> > > Also the maven archetype for component should include all of this also.
> > >
> > > On Wed, Mar 6, 2019 at 12:07 PM Stefan Ziegler
> > > <stefan.ziegler.de@gmail.com> wrote:
> > > >
> > > > Hi
> > > >
> > > > I'm writing my first apache camel component:
> > > > https://github.com/edigonzales/camel-ili2pg
> > > >
> > > > I'm wondering how to get the automatic documentation of the
> component and
> > > > endpoint options in the asciidoc file? I have put an emtpy .adoc
> file in
> > > > src/main/docs/ only with
> > > >
> > > > // component options: START
> > > > // component options: END
> > > >
> > > > // endpoint options: START
> > > > // endpoint options: END
> > > >
> > > > written in it.
> > > >
> > > > I then run "mvn clean install" but I couldn't find any updated / new
> > > > asciidoc file with the component options. Endpoints etc are
> annotated.
> > > >
> > > > Thanks for any hints.
> > > > regards
> > > > Stefan
> > >
> > >
> > >
> > > --
> > > Claus Ibsen
> > > -----------------
> > > http://davsclaus.com @davsclaus
> > > Camel in Action 2: https://www.manning.com/ibsen2
> > >
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message