[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [equinox-dev] .qualifier for export package?

Darin Wright
Eclipse Debug Lead,
Rational Team,
IBM Canada
(204)938-8051

equinox-dev-bounces@xxxxxxxxxxx wrote on 09/02/2008 01:59:00 PM:

> 
> > Here are some obvious questions:
> > 
> > * How are @since tags formatted to indicate that the version number 
> > corresponds to packages vs. bundles?
> 
> If there is a package version then the @since should always reference
> the package version exported in my opinion.

Right, but since package versions will now evolve independently of bundle 
versions, should the package name also appear in the @since tag - like 
"@since org.eclipse.jdt.debug.model 3.4". Else, when just looking at the 
Javadoc, consumers of an API will not know if they need a required bundle 
or a package import.

> 
> > * How are initial package versions derived for existing bundles?
> 
> The simple answer here is to seed the package versions with the 
> bundle's version.  This makes some sense because using the Eclipse 
> versioning rules today the API packages from a single bundle are 
> versioned together as one unit using the Bundle-Version.

Another option is to use the highest @since tag in the package. If a most 
recent since tag in a package is 3.1, it could start at 3.1 instead of 
3.5.

Darin