peterdemaeyer commented on PR #827: URL: https://github.com/apache/commons-io/pull/827#issuecomment-3939266920
> Hi @peterdemaeyer > > Trying to use headers like `<h4>` in Javadoc is an exercise in frustration. Different versions seems to have different rules. We do use `<h2>` without errors, for example in `org.apache.commons.lang3.function.MethodInvokers`'s class Javadoc. I don't think you can use an HTML header in a way that'll work across all the versions we support, all LTS versions. I would keep it simple and use `\<strong\>` or `\<em\>`. > Hi @peterdemaeyer > > Trying to use headers like `<h4>` in Javadoc is an exercise in frustration. Different versions seems to have different rules. We do use `<h2>` without errors, for example in `org.apache.commons.lang3.function.MethodInvokers`'s class Javadoc. I don't think you can use an HTML header in a way that'll work across all the versions we support, all LTS versions. I would keep it simple and use `\<strong\>` or `\<em\>`. Okay, I'll change it, but beware that I didn't randomly pick `<h4>`, I was following [this](https://download.java.net/java/early_access/loom/docs/specs/javadoc/doc-comment-spec.html) recommendation that says: _"headings in the documentation comments for constructors, methods, fields and other members should start at heading level 4."_ Your example of `<h2>` for _class_ JavaDoc is also in line with that same specification by the way: _"comments for module, package, and type declarations (including nested types) should start at [heading level](https://html.spec.whatwg.org/multipage/sections.html#heading-level) 2"_. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
