eessppeelllloo/processing4
1
0
Fork 0
mirror of https://github.com/processing/processing4.git synced 2026-01-27 18:31:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Formatting more comments

Browse Source
This commit is contained in:
Anadroid
2021-04-12 10:24:07 +02:00
parent 69700fbeeb
commit 7b5c8ba9ce
18 changed files with 132 additions and 132 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
java/libraries/io/src/processing/io/GPIO.java
View File

@@ -94,16 +94,16 @@ public class GPIO {
/**
* Calls a function when the value of an input pin changes<br/>
* <br/>
* The sketch method provided must accept a single integer (int) parameter, which is the
* The sketch method provided must accept a single <b>integer</b> (int) parameter, which is the
* number of the GPIO pin that the interrupt occured on. As this method might be called
* at any time, including when drawing to the display window isn't permitted, it is best
* to only set simple variables that are being responded to in the next draw() call, as
* to only set simple variables that are being responded to in the next <b>draw()</b> call, as
* shown above. Calling functions of the Hardware I/O library at this point is certainly
* possible.<br/>
* <br/>
* The mode parameter determines when the function will be called: GPIO.FALLING occurs
* when the level changes from high to low, GPIO.RISING when the level changes from low
* to high, and GPIO.CHANGE when either occurs.
* The mode parameter determines when the function will be called: <b>GPIO.FALLING</b> occurs
* when the level changes from high to low, <b>GPIO.RISING</b> when the level changes from low
* to high, and <b>GPIO.CHANGE</b> when either occurs.
*
* @param pin GPIO pin
* @param parent typically use "this"
@@ -333,7 +333,7 @@ public class GPIO {
* Allows interrupts to happen<br/>
* <br/>
* You can use <a href="GPIO_noInterrupts_.html">noInterrupts()</a>
* and interrupts() in tandem to make sure no interrupts are occuring
* and <b>interrupts()</b> in tandem to make sure no interrupts are occuring
* while your sketch is doing a particular task. By default, interrupts
* are enabled.
*
@@ -351,7 +351,7 @@ public class GPIO {
/**
* Prevents interrupts from happpening<br/>
* <br/>
* You can use noInterrupts() and <a href="GPIO_interrupts_.html">interrupts()</a>
* You can use <b>noInterrupts()</b> and <a href="GPIO_interrupts_.html">interrupts()</a>
* in tandem to make sure no interrupts are occuring while your sketch is doing a
* particular task.<br/>
* br/>
@@ -529,9 +529,9 @@ public class GPIO {
/**
* Waits for the value of an input pin to change<br/>
* <br/>
* The mode parameter determines when the function will return: GPIO.FALLING occurs
* when the level changes from high to low, GPIO.RISING when the level changes from
* low to high, and GPIO.CHANGE when either occurs.<br/>
* The mode parameter determines when the function will return: <b>GPIO.FALLING</b> occurs
* when the level changes from high to low, <b>GPIO.RISING</b> when the level changes from
* low to high, and <b>GPIO.CHANGE</b> when either occurs.<br/>
* <br/>
* The optional timeout parameter determines how many milliseconds the function will
* wait at the most. If the value of the input pin hasn't changed at this point, an
@@ -550,9 +550,9 @@ public class GPIO {
/**
* Waits for the value of an input pin to change<br/>
* <br/>
* The mode parameter determines when the function will return: GPIO.FALLING occurs
* when the level changes from high to low, GPIO.RISING when the level changes from
* low to high, and GPIO.CHANGE when either occurs.<br/>
* The mode parameter determines when the function will return: <b>GPIO.FALLING</b> occurs
* when the level changes from high to low, <b>GPIO.RISING</b> when the level changes from
* low to high, and <b>GPIO.CHANGE</b> when either occurs.<br/>
* <br/>
* The optional timeout parameter determines how many milliseconds the function will
* wait at the most. If the value of the input pin hasn't changed at this point, an

12
java/libraries/io/src/processing/io/I2C.java
View File

@@ -150,7 +150,7 @@ public class I2C {
* <br/>
* This executes any queued writes. <a href="I2C_read_.html">Read()</a>
* implicitly ends the current transmission as well, hence calling
* endTransmission() afterwards is not necessary.
* <b>endTransmission()</b> afterwards is not necessary.
*
* @see beginTransmission
* @see write
@@ -212,10 +212,10 @@ public class I2C {
/**
* Read bytes from the attached device<br/>
* <br/>
* You must call beginTransmission() before calling this function. This function
* You must call <b>beginTransmission()</b> before calling this function. This function
* also ends the current transmission and sends any data that was queued using
* write() before. It is not necessary to call
* <a href="I2C_endTransmission_.html">endTransmission()</a> after read().
* <b>write()</b> before. It is not necessary to call
* <a href="I2C_endTransmission_.html">endTransmission()</a> after <b>read()</b>.
*
* @param len number of bytes to read
* @return bytes read from device
@@ -253,8 +253,8 @@ public class I2C {
/**
* Add bytes to be written to the device<br/>
* <br/>
* You must call beginTransmission() before calling this function. The actual
* writing takes part when read() or endTransmission() is being called.
* You must call <b>beginTransmission()</b> before calling this function. The actual
* writing takes part when <b>read()</b> or <b>endTransmission()</b> is being called.
*
* @param out bytes to be written
* @see beginTransmission

10
java/libraries/io/src/processing/io/SoftwareServo.java
View File

@@ -83,10 +83,10 @@ public class SoftwareServo {
/**
* Attaches a servo motor to a GPIO pin<br/>
* <br/>
* You must call this function before calling write(). Note that the servo motor
* will only be instructed to move after the first time write() is called.<br/>
* You must call this function before calling <b>write()</b>. Note that the servo motor
* will only be instructed to move after the first time <b>write()</b> is called.<br/>
* <br/>
* The optional parameters minPulse and maxPulse control the minimum and maximum
* The optional parameters <b>minPulse</b> and <b>maxPulse</b> control the minimum and maximum
* pulse width durations. The default values, identical to those of Arduino's
* Servo class, should be compatible with most servo motors.
*
@@ -105,8 +105,8 @@ public class SoftwareServo {
/**
* Attaches a servo motor to a GPIO pin<br/>
* <br/>
* You must call this function before calling write(). Note that the servo motor
* will only be instructed to move after the first time write() is called.<br/>
* You must call this function before calling <b>write()</b>. Note that the servo motor
* will only be instructed to move after the first time <b>write()</b> is called.<br/>
* <br/>
* The optional parameters minPulse and maxPulse control the minimum and maximum
* pulse width durations. The default values, identical to those of Arduino's

8
java/libraries/serial/src/processing/serial/Serial.java
View File

@@ -198,10 +198,10 @@ public class Serial implements SerialPortEventListener {
/**
* Sets the number of bytes to buffer before calling serialEvent()
* Sets the number of bytes to buffer before calling <b>serialEvent()</b>
* @generate Serial_buffer.xml
* @webref serial
* @webBrief Sets the number of bytes to buffer before calling serialEvent()
* @webBrief Sets the number of bytes to buffer before calling <b>serialEvent()</b>
* @usage web_application
* @param size number of bytes to buffer
*/
@@ -722,7 +722,7 @@ public class Serial implements SerialPortEventListener {
/**
* Writes bytes, chars, ints, bytes[], Strings to the serial port
* Writes <b>bytes</b>, <b>chars</b>, <b>ints</b>, <b>bytes[]</b>, <b>Strings</b> to the serial port
*
* <h3>Advanced</h3>
* Write a String to the output. Note that this doesn't account
@@ -737,7 +737,7 @@ public class Serial implements SerialPortEventListener {
* (i.e. UTF8 or two-byte Unicode data), and send it as a byte array.
*
* @webref serial
* @webBrief Writes bytes, chars, ints, bytes[], Strings to the serial port
* @webBrief Writes <b>bytes</b>, <b>chars</b>, <b>ints</b>, <b>bytes[]</b>, <b>Strings</b> to the serial port
* @usage web_application
* @param src data to write
*/