[infinispan-dev] Missing javadoc for indexing annotations

[Sanne Grinovero]

Yes linking would be appropriate for some areas, but at least DSL and
indexing annotations should show up in the index I think.

Regarding Maven what a mess!

Anyway I'm still missing something about the structure in Infinispan, as it
ignores whatever option I change.
Il giorno 30/gen/2013 00:12, "Randall Hauch" <rhauch at redhat.com> ha scritto:

> IIRC, aggregating JavaDocs like that causes a mess of the build system,
> because everything will be built and tests run twice. See
> https://issues.jboss.org/browse/MODE-1104 for background (including the
> pull-request). It's probably not easy to figure out how it works, but I
> could explain it fairly quickly if you cared.
>
> Isn't it much easier to simply have the Infinispan JavaDoc be able to link
> to the Hibernate Search JavaDoc site? It's not ideal, but it's far simpler.
> Perhaps the Infinispan Query JavaDocs could link back to the Hibernate
> Search JavaDocs? (Yes, there would be a chicken-and-egg problem, but the
> links in the first would simply not be available until the second were
> built.)
>
> This is how ModeShape JavaDocs are built to link to several other JavaDoc
> sites:
>
> https://github.com/ModeShape/modeshape/blob/master/modeshape-distribution/pom.xml#L427
>
> On Jan 29, 2013, at 5:12 PM, Sanne Grinovero <sanne at infinispan.org> wrote:
>
> > The javadoc of Infinispan does not have references to the Hibernate
> > Search API; this is quite uncomfortable for Infinispan Query users: I
> > think we should at least import the annotations and the DSL docs.
> >
> > http://docs.jboss.org/infinispan/5.2/apidocs/
> > http://docs.jboss.org/hibernate/search/4.2/api/
> >
> > Would you agree in merging the docs from hibernate-search-engine ?
> >
> > Also, I was looking at how this could be done [1]. I have been playing
> > with the maven-javadoc-plugin configuration section under the
> > distribution profile, but it seems to be ignored.
> >
> >> From the Infinispan source code root I'm running
> >> mvn javadoc:aggregate -Pdistribution
> >
> > this does produce javadoc in the /target/site/apidocs but seems to
> > ignore any configuration option.
> > what am I missing?
> >
> > Cheers,
> > Sanne
> >
> > 1 -
> http://maven.apache.org/plugins/maven-javadoc-plugin/examples/aggregate-dependency-sources.html
> > _______________________________________________
> > infinispan-dev mailing list
> > infinispan-dev at lists.jboss.org
> > https://lists.jboss.org/mailman/listinfo/infinispan-dev
>
>
> _______________________________________________
> infinispan-dev mailing list
> infinispan-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/infinispan-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.jboss.org/pipermail/infinispan-dev/attachments/20130130/911e14bd/attachment.html