Hi James, For some reason, Drill started with the license headers in Javadoc comments. The (weak) explanation I got was that we never generate Javadoc, so it didn't really matter. Later, we started converting the headers to regular comments when convenient.
If we were to generate Javadoc, having the license at the top of each page as the summary for each class would probably not be something that anyone finds useful. I don't know how to configure the license plugin. But, I do suspect a Python file (or shell script) could make a one-time pass over the files to standardize headers into whatever format the team chooses. Only the first line of each file would change. - Paul On Thu, Jan 25, 2024 at 11:22 PM James Turton <dz...@apache.org> wrote: > Good morning! > > I'd like to ask about a feature to prevent RAT from allowing license > headers to appear inside Javadoc comments (/**) while still requiring > them in Java comments (/*) in .java files. Currently the Drill project > makes use of com.mycila.license-maven-plugin to reject licenses in > Javadoc comments because the developers at the time didn't want license > headers cluttering the Javadoc website that is generated from the > source. Are you aware of a general view on Apache license headers > appearing in Javadoc pages? If preventing them from doing so is a good > idea, could this become a (configurable) feature in RAT? > > Thanks > James Turton >
