search

scijava / script-editor-jython

Jython plugin for the SciJava Script Editor
BSD 2-Clause "Simplified" License
2 stars 2 forks source link

Disable DocLint #7

Closed tferr closed 2 years ago

tferr commented 2 years ago

This should allow CI builds: Currently, Javadoc generation seems to be failing due to bad Javadoc annotations. Disabling DocLint should allow the build to progress. We should however fix those issues for proper documentation

tferr commented 2 years ago

@acardona, it looks like Javadocs could not be built because the over-zealous rules of doc-lint were enabled by default. We should address those, but for now, I was thinking one could temporarily disable it, and deal with it later on. I propose:

  1. We disable it by merging this PR
  2. We open an issue to remind us that we should fix the offending Javadoc annotations.
acardona commented 2 years ago

I've spent a few minutes reviewing the javadocs, pushed a fix and released it. Let's see if it goes through; there were indeed a couple of @param without the word param in them.

acardona commented 2 years ago

OK my attempt was hopeless: the javadoc linter wants indeed perfect and complete javadocs.