Bug#423473: libqdox-java: Descriptions need improvement

[Josh Triplett]

Package: libqdox-java
Severity: normal

The current description of libqdox-java:

Description: High speed source parser for extracting from Java class/method definitions
 The parser skims the source files only looking for things of interest such as
 class/interface definitions, import statements, JavaDoc and member
 declarations. The parser ignores things such as actual method implementations
 to avoid overhead (while in method blocks, curly brace counting suffices).
 .
 The end result of the parser is a very simple document model containing enough
 information to be useful.

The short description has too many characters, and the long description does
not stand on its own separately from the short description.  Suggested
replacement:

Description: Quickly parses declarations and Javadoc from Java source
 qdox quickly parses Java source files looking for key items of interest:
  * class and interface definitions
  * member declarations
  * import statements
  * JavaDoc comments
 .
 qdox ignores all other components of Java source, such as actual method
 implementations, to avoid overhead.  qdox returns a simple document model
 containing only the declarations and containing enough information to be
 useful.


The current description of libqdox-java-doc:

Description: Documentation for the qdox package
 Javadoc only.


This does not describe qdox at all, and the long description does not stand on
its own separately from the short description.  It should say something like:

Description: Documentation for qdox (javadoc)

 This package contains the documentation for qdox, generated from Javadoc.
 .
 (description of libqdox-java)

- Josh Triplett

-- System Information:
Debian Release: lenny/sid
  APT prefers unstable
  APT policy: (500, 'unstable'), (1, 'experimental')
Architecture: i386 (i686)

Kernel: Linux 2.6.18-josh (PREEMPT)
Locale: LANG=en_US.UTF-8, LC_CTYPE=en_US.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/bash