markdown-doclet icon indicating copy to clipboard operation
markdown-doclet copied to clipboard

Overview Page Not Included When Generating For Single Package

Open OzWolf opened this issue 9 years ago • 4 comments

When JavaDoc is generated using the Pegdown Doclet and the only classes being included are from the single package, any included overview page is excluded.

Usage

Maven Plugin

Test Cases

  • All classes are in the same single package.
  • Classes are in various packages with all but one package in the excludePackageNames property.

Standard JavaDoc Behaviour

When using the standard JavaDoc Maven plugin, the above test cases still include the provided overview page.

OzWolf avatar Sep 10 '14 02:09 OzWolf

Actually, that's JavaDoc ignoring overview.md. It does the same when using the Standard doclet: If there's only one package, its description is used instead of overview.html.

Abnaxos avatar May 13 '15 15:05 Abnaxos

Oops, sorry. Well, when I tested, it was the same, the issue states otherwise. Will re-check.

Abnaxos avatar May 13 '15 15:05 Abnaxos

I'll run a quick reconfirmation test tomorrow as well.

OzWolf avatar May 14 '15 11:05 OzWolf

I can also reproduce this from gradle. When I add an exclude rule, the overview file is not used in the generated html.

jcayzac avatar Feb 27 '17 07:02 jcayzac