[hibernate-dev] Marking API members as incubating

Gunnar Morling gunnar at hibernate.org
Thu Jul 11 06:22:42 EDT 2013


2013/7/11 Sanne Grinovero <sanne at hibernate.org>

> Indeed in my previous comment about bundling it in a common jar I was
> assuming the retention would have been at source level.
>
> Hardy suggested we could keep it even at runtime.. indeed that could
> open the path for several kinds of diagnostics and reporting. I guess
> there is no downside? I don't expect these to take more than a couple
> of bytes in the class definitions.
>
> +1 to just include it in the source tree, but in that case I'm not
> sure I'm understanding the additional value over the current
> @Experimental?
>

What is @Experimental here, a JavaDoc tag or an annotation? IMO an
annotation is advantageous for the reasons outlined in my initial mail.


>
> Cheers,
> Sanne
>
> On 11 July 2013 10:11, Hardy Ferentschik <hardy at hibernate.org> wrote:
> >
> > On 10 Jan 2013, at 11:07 PM, Gunnar Morling <gunnar at hibernate.org>
> wrote:
> >
> >> 2013/7/10 Steve Ebersole <steve at hibernate.org>
> >>
> >>> http://www.gradle.org/docs/current/userguide/feature_lifecycle.html
> >>
> >>
> >> Thanks for the link. I like their approach of explicitly documenting
> this
> >> kind of thing.
> >
> > I think we might have to differentiate here. I also like the clear
> documentation of Gradle,
> > but having an @Incubating annotation is imo not a requirement for that.
> We could create
> > something similar on our wiki or include into our online docs. It could
> mention Experimental
> > javadoc in our case.
> >
> > --Hardy
> > _______________________________________________
> > hibernate-dev mailing list
> > hibernate-dev at lists.jboss.org
> > https://lists.jboss.org/mailman/listinfo/hibernate-dev
> _______________________________________________
> hibernate-dev mailing list
> hibernate-dev at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/hibernate-dev
>


More information about the hibernate-dev mailing list