pi4j-v2 icon indicating copy to clipboard operation
pi4j-v2 copied to clipboard

JavaDoc improvements

Open FDelporte opened this issue 5 months ago • 1 comments
trafficstars

Proposed by @APIdia-net

turn the inline {@see } into {@link }. Looking at the @return, I can just add a description for the one in com.pi4j.io.i2c.I2C.execute:

Executes the given runnable on the I2C bus, locking the bus for the duration of the given task
@param action the action to perform, returning a value

@param <T> the result type of the action to perform

@return the result of the performed action

Looking at [gpioClock](https://apidia.net/mvn/com.pi4j/pi4j/3.0.1/?pck=com.pi4j.library.pigpio&cls=.PiGpio#gpioCfgClock-int-int-int-), it is not trivial to guess the meaning of the return value. Maybe it's the value that has actually been set, perhaps since it might differ from the value requested...?
@return the actual new sample rate

FDelporte avatar Jun 06 '25 09:06 FDelporte

As you identified. A great deal of review. If done:. I think you run some wild sed script or however you do it and take a guess at the meaning but end the sentence with some eyecatcher. Then we can find the entries not reviewed and accept the wording or change it but remove the eye catcher when completed

taartspi avatar Jun 13 '25 19:06 taartspi