Bug#1108461: libdvdread-dev: Please generate API documentation for this package
Package: libdvdread-dev
Version: 6.1.3-2
Severity: normal
Tags: upstream
X-Debbugs-Cc: borden_c@tutanota.com
Good morning,
It's very difficult for a newcomer to understand how to use this package and
link to libdvdread. Specifically, the README.md provides no explanation on how
to use this library. The two links it provides under the heading "Using
libdvdread" link to very old information about the DVD Video format in general,
*not* how to use the library (the links even incorrectly cite the library being
at version 5, not 6).
There appears, under the upstream source `doc` folder, configs to generate
DOxygen documentation. It would be very helpful for this deb, at a minimum, to
ship with compiled DOxygen documentation in the share/doc folder. It defeats
this package's purpose of having header files, but then having to download the
full source to complile DOxygen.
A tutorial and/or example files calling this library would also be very
helpful, and really should be provided upstream, where perhaps an issue should
also be filed.
-- System Information:
Debian Release: 13.0
APT prefers testing
APT policy: (501, 'testing'), (500, 'testing-debug')
Architecture: amd64 (x86_64)
Foreign Architectures: i386
Kernel: Linux 6.12.33+deb13-amd64 (SMP w/4 CPU threads; PREEMPT)
Locale: LANG=en_CA.UTF-8, LC_CTYPE=en_CA.UTF-8 (charmap=UTF-8), LANGUAGE=en_GB
Shell: /bin/sh linked to /usr/bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled
Versions of packages libdvdread-dev depends on:
ii libdvdread8t64 6.1.3-2
ii pkgconf 1.8.1-4
libdvdread-dev recommends no packages.
Versions of packages libdvdread-dev suggests:
ii libdvd-pkg [libdvdcss-dev] 1.4.3-1-1.1
ii libdvdcss-dev 1.4.3-1~local
-- no debconf information
Reply to: