Fix javadoc errors about oscar4 HOT 7 CLOSED

I think, with the help of @dan2097 , we have resolved most of the showstopping javadoc issues. I will release 5.0.0 very soon.

from oscar4.

This is actually taking much more time then I had initially planned; the fixes I have done thus far are only for one module. I am going to disable the doc linting as a short term fix.

from oscar4.

I can deploy 5.0.0 with the javadoc linting disabled, but it would be nice to fix this at this moment. Do either of you @petermr @merkys have resource to chase down the javadoc issues in the other modules?

from oscar4.

Is this the limit of the errors? Javadoc can be very (unnecessarily) picky. If it was thrown at my AMY code there would be zillions of these

I have just migrated to IntelliJ from Eclipse - I don't know whether it has help for this. But I'd just go with no-linting it... Commenting the params requires you to know or guess what they mean (and I do not know)

from oscar4.

Yes; the errors are only Javadoc. I think going from JDK 1.5 to 1.8, the standards have tightened. My issue is that, as you say, I cannot always work out what the parameters mean and also the sheer number of them.

from oscar4.

Do either of you @petermr @merkys have resource to chase down the javadoc issues in the other modules?

I also do not have enough knowledge about the project to dare to comment on parameters.

from oscar4.

What worked well in the CDK was to report the problems, ideally split up, but not fail on it. That way, it becomes clear where major problems are with lacking documentation and it gamifies the problem: it is rewarding to make a part of the code base it 100% green. Another tip: methods that override another method, can inherit the documentation.

from oscar4.