Overview Page Not Included When Generating For Single Package

Abnaxos / markdown-doclet

A Doclet that allows the use of Markdown in JavaDoc comments.

GNU General Public License v3.0

319 stars 40 forks source link

Overview Page Not Included When Generating For Single Package #29

Open OzWolf opened 10 years ago

OzWolf commented 10 years ago

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.

Abnaxos commented 9 years ago

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 commented 9 years ago

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

OzWolf commented 9 years ago

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

jcayzac commented 7 years ago

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