On 20/05/2021 15:36, Neale Rudd wrote:
Hi All,
I am currently working on a new catalina filter for Tomcat.
I will submit my ideas and code for discussion using Bugzilla.
I'd recommend you do that earlier rather than later. I wouldn't want you
spend time producing this filter only to find out that the Tomcat
community doesn't want to include it.
While I was able to find the style guide and submissions guide, I still
have a few questions about the process:
- Romain has pointed me to
https://github.com/apache/tomcat/blob/master/webapps/docs/config/filter.xml
for adding a documentation diff, so I think I have that covered
- should I submit a separate javax and jakarta version or is someone in
charge of backports?
So far, the javax / jakarta switch hasn't caused too many issues for
back-ports. I'd suggest starting with a patch/PR against 10 and we
should be able to back-port fairly automatically.
- is there a way to generate the javadoc for the class?ￂﾠ I can't see
comments above the functions in the other filters, so is this manually
written in HTML or is there a file which automatically generates it
separate to the source code?ￂﾠ For example, how is
https://tomcat.apache.org/tomcat-8.0-doc/api/org/apache/catalina/filters/HttpHeaderSecurityFilter.html
created?
Nope. All the Javadoc is generated from the source code. Keep in mind
that classes automatically inherit Javadoc from their superclass.
Generally, we try and keep unnecessary code out of the codebase so we
don't use @inheritDoc where we don't have to.
- is there anything else which I should be submitting along with the new
class?
A changelog entry is always appreciated.
I couldn't find the answers to these questions in the submission
guidelines so I'm asking here.
It may also be helpful if the answers were added to the submission guide
page for other new contributors to avoid them asking the same questions.
Patches for the submissions guide, style guide and other docs are as
welcome as those for the code.
Mark
-
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
