markdown-doclet
markdown-doclet copied to clipboard
Overview Page Not Included When Generating For Single Package
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.
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.
Oops, sorry. Well, when I tested, it was the same, the issue states otherwise. Will re-check.
I'll run a quick reconfirmation test tomorrow as well.
I can also reproduce this from gradle. When I add an exclude
rule, the overview file is not used in the generated html.