Handling of headings in doc comments

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

Handling of headings in doc comments #8

Open Abnaxos opened 11 years ago

Abnaxos commented 11 years ago

Change rendering of headings: Render h1 as h3, h2 as h4, etc. This probably makes much more sense than not using h1 at all and starting with h2 in doc comments (as I currently do). Have a closer look at how hX elements are currently used by the standard doclet and the API documentation, and how we best fit in with headings in the doc comments. Alternatively, just adapt the CSS.

Note: This may break compatibility with older versions.

Abnaxos commented 11 years ago

Downgrade H1 comments to H2 in package-info.java and overview.md, to H3 in class descriptions, H5 in member descriptions.
If a header ends up with H7, H8 etc, issue a warning and keep at H6.
Issue a warning if headers are used in tags and downgrade to H6.