Remove sim checkstyle suppressions

[Starlight220]

Fixes #1290

• add comment about saving the CallbackStore object so GC doesn't cancel the callback.

[Starlight220]

@AustinShalit - Most of the checkstyle errors are AbbreviationAsWordInName for FGPA or RIO. What should I do with them?
And what are the guidelines for wrapping Java param lists?
And what should be the javadoc for the SimValueInfo ctor?

[AustinShalit]

I would leave AbbreviationAsWordInName for now. Just apply the others in this PR

I am not exactly sure. I think @PeterJohnson might have a better answer than what I can give.

[PeterJohnson]

Both SimValueInfo and SimDeviceInfo (earlier in the same file) are structures that contain information about the simulated value and simulated device as returned by the corresponding Enumerate functions. Those constructors are only called from the native side and are not intended to be called by users.

[Starlight220]

So should I @SuppressWarnings("JavadocMethod") it? And what about the AbbreviationAsWordInName errors?

[Starlight220]

I'm just putting @SuppressWarnings() on almost all of the errors...

[Starlight220]

@PeterJohnson - what should I do with missing Javadocs on CallbackStore.java? And I'm suppressing NoFinalizer on that file. I'm also suppressing any naming issues (ParameterName, etc).

• Javadoc on Field2d ctor missing
• GenericHIDSim, JoystickSim, SimDeviceSim, XBoxController need Javadocs

Many of the needed Javadocs are for get/set/callback sets. I can write the get/set Javadocs as "<Gets/Sets> the property of the simulated object.". Would that be enough?

[Starlight220]

It's waiting only on missing Javadoc errors.

[PeterJohnson]

Yep, for get/set/callback you can just use a generic description.

CallbackStore keeps track of a simulation callback and cancels the callback when close() is called. The different constructors are for index-based, channel-based, or general (no index) callbacks.

Field2d constructor simply creates a Field2d object. There's no args to discuss.

[Starlight220]

allwpilib/wpilibj/src/main/java/edu/wpi/first/wpilibj/simulation/GenericHIDSim.java

Line 79 in b66fcdb

public void setAxisType(int axis, int type) {

I think that this type int should be some sort of enum... Or at least docs as to the different values possible

And in all the registerXxxCallback functions I'm assuming that the initialNotify parameter decides if the callback is called with the initial value.

The CallbackStore ctors should only be accessed from the XxxSim classes, right? They aren't for team usage?

[PeterJohnson]

It’s the same type as Joystick.getAxisType returns, so we probably need to document both.

You are correct on what initialNotify does.

Yeah, CallbackStore is an implementation detail; teams generally shouldn’t need to use it directly.

[Starlight220]

What's up with the CI?

[AustinShalit]

What's up with the CI?

GitHub was having issues earlier today. I am going to rerun and see if that helps.

[Starlight220]

Watchdog tests failing? Again?

[calcmogul]

That's a known issue.

[PeterJohnson]

I cleaned this up as #3079.