Log of pi4j 3.0.1

Documentation Report

com.pi4j

Warnings

@return declared without description: 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>

@return

com.pi4j.library.gpiod

Javadoc Processing

inline see: File#createTempFile(java.lang.String, java.lang.String): @see in com.pi4j.library.gpiod.util.NativeLibraryLoader.loadLibraryFromClasspath

Loads library from classpath
<p>
The file from classpath is copied into system temporary directory and then loaded. The temporary file is
deleted after exiting. Method uses String as filename because the pathname is
"abstract", not system-dependent.
@param path

The file path in classpath as an absolute path, e.g. /package/File.ext (could be inside jar)

@throws IOException

If temporary file creation or read/write operation fails

@throws IllegalArgumentException

If source file (param path) does not exist

@throws IllegalArgumentException

If the path is not absolute or if the filename is shorter than three characters (restriction

of {@see File#createTempFile(java.lang.String, java.lang.String)}).

com.pi4j.library.linuxfs

Javadoc Processing

inline see: File#createTempFile(java.lang.String, java.lang.String): @see in com.pi4j.library.linuxfs.util.NativeLibraryLoader.loadLibraryFromClasspath

Loads library from classpath
<p>
The file from classpath is copied into system temporary directory and then loaded. The temporary file is
deleted after exiting. Method uses String as filename because the pathname is
"abstract", not system-dependent.
@param path

The file path in classpath as an absolute path, e.g. /package/File.ext (could be inside jar)

@throws IOException

If temporary file creation or read/write operation fails

@throws IllegalArgumentException

If source file (param path) does not exist

@throws IllegalArgumentException

If the path is not absolute or if the filename is shorter than three characters (restriction

of {@see File#createTempFile(java.lang.String, java.lang.String)}).

com.pi4j.library.pigpio

Javadoc Processing (1)

inline see: File#createTempFile(java.lang.String, java.lang.String): @see in com.pi4j.library.pigpio.util.NativeLibraryLoader.loadLibraryFromClasspath

Loads library from classpath
<p>
The file from classpath is copied into system temporary directory and then loaded. The temporary file is
deleted after exiting. Method uses String as filename because the pathname is
"abstract", not system-dependent.
@param path

The file path in classpath as an absolute path, e.g. /package/File.ext (could be inside jar)

@throws IOException

If temporary file creation or read/write operation fails

@throws IllegalArgumentException

If source file (param path) does not exist

@throws IllegalArgumentException

If the path is not absolute or if the filename is shorter than three characters (restriction

of {@see File#createTempFile(java.lang.String, java.lang.String)}).

Warnings

@return declared without description: in com.pi4j.library.pigpio.PiGpio.gpioCfgClock

Configures pigpio to use a particular sample rate timed by a specified peripheral.
This function is only effective if called before gpioInitialise.
The timings are provided by the specified peripheral (PWM or PCM).
The default setting is 5 microseconds using the PCM peripheral.
@param cfgMicros 1, 2, 4, 5, 8, 10

@param cfgPeripheral 0 (PWM), 1 (PCM)

@param cfgSource deprecated, value is ignored

@return

@return declared without description: in com.pi4j.library.pigpio.internal.PIGPIO.gpioCfgClock

Configures pigpio to use a particular sample rate timed by a specified peripheral.
This function is only effective if called before gpioInitialise.
The timings are provided by the specified peripheral (PWM or PCM).
The default setting is 5 microseconds using the PCM peripheral.
@param cfgMicros     1, 2, 4, 5, 8, 10

@param cfgPeripheral 0 (PWM), 1 (PCM)

@param cfgSource     deprecated, value is ignored

@return

com.pi4j.plugin.gpiod

com.pi4j.plugin.linuxfs

com.pi4j.plugin.mock

com.pi4j.plugin.pigpio

com.pi4j.test

Notes

On inline see

APIdia does support inline use of @see as follows. For an inline occurrence of {@see ...},

1. the occurrence is replaced by {@link ...} (program elements) or wrapped into an html <a> tag (external links) and
2. a block tag @see ... is appended.

This is still logged as an issue, because inline use of @see is considered invalid Javadoc.