[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Location of API docs



Marcus Better writes:
> Matthias Klose wrote:
> >> which seems more sensible to me. Should I change it to
> >> /usr/share/doc/$package/api? I assume I should also create a doc-base.
> 
> > where $package is the name of the library package, not the name of the
> > doc package (if there exists an extra -doc package).
> 
> How come? I thought we put api docs in the -doc package, if there is
> one.

exactly, but into the /usr/share/doc/$package/api directory, not into
the /usr/share/doc/$package-doc/api directory.

> > The idea was to make the -doc packages depend on other -doc packages
> > so that references to other packages can be resolved;
> 
> Seems more reasonable to build-depend on the other doc packages to get the
> references right,

sure, if you get this working, this would be fine. Please summarize on
the list.

> and then Recommend or Suggest the others. For example,
> you can make good use of api docs for a library without having
> classpath-doc.

Recommends sounds be useful.

  Matthias



Reply to: