Skip to content

Commit

Permalink
javadoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
supertick committed Dec 10, 2023
1 parent 85e5388 commit 47133b9
Show file tree
Hide file tree
Showing 13 changed files with 13 additions and 63 deletions.
14 changes: 5 additions & 9 deletions src/main/java/org/myrobotlab/net/SslUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,14 @@ public class SslUtil {
* Returns a SSLSocketFactory if provided with a x509 cert, and key file. The
* caCrtFile is the certificate authority root and inpassword is the protected
* password of the cert "if suppied". If unprotected leave null or empty "".
* @param sslCaFilePath - ca root
* @param sslCertFilePath - certificate file (pem)
* @param sslKeyFilePath - private key
* @param sslPassword - password if key/cert are protected by a password
*
* @param caCrtFile
* - ca root
* @param crtFile
* - certificate file (pem)
* @param keyFile
* - private key
* @param inpassword
* - password if key/cert are protected by a password
* @return the ssl socket factory
* @throws Exception
* boom
*
*/

public static SSLSocketFactory getSocketFactory(String sslCaFilePath, String sslCertFilePath, String sslKeyFilePath, String sslPassword) throws Exception {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/myrobotlab/programab/PredicateEvent.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
*/
public class PredicateEvent {
/**
* unique identifier for the session user & bot
* unique identifier for the session user and bot
*/
public String id;
/**
Expand Down
5 changes: 2 additions & 3 deletions src/main/java/org/myrobotlab/service/LocalSpeech.java
Original file line number Diff line number Diff line change
Expand Up @@ -359,9 +359,8 @@ public boolean setPico2Wav() {
* Typically double quotes should be filtered out of the command as creating
* the text to speech process command can be broken by double quotes
*
* @param filter
* chars to filter.
*
* @param target
* @param replace
*/
public void addFilter(String target, String replace) {
LocalSpeechConfig c = (LocalSpeechConfig) config;
Expand Down
1 change: 0 additions & 1 deletion src/main/java/org/myrobotlab/service/NeoPixel.java
Original file line number Diff line number Diff line change
Expand Up @@ -927,7 +927,6 @@ public void setPixel(int address, int red, int green, int blue, int white) {
* @param green
* @param blue
* @param white
* @param delayMs
*/
public void setPixel(String matrixName, Integer pixelSetIndex, int address, int red, int green, int blue, int white) {
// get and update memory cache
Expand Down
20 changes: 0 additions & 20 deletions src/main/java/org/myrobotlab/service/NovelAI.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,26 +30,6 @@ public NovelAI(String n, String id) {
client = new OkHttpClient();
}

/**
* The methods apply and getConfig can be used, if more complex configuration
* handling is needed. By default, the framework takes care of most of it,
* including subscription handling.
*
* <pre>
&#64;Override
public ServiceConfig apply(ServiceConfig c) {
super.apply(c)
return c;
}
@Override
public ServiceConfig getConfig() {
super.getConfig()
return config;
}
* </pre>
**/

public static void main(String[] args) {
try {

Expand Down
3 changes: 1 addition & 2 deletions src/main/java/org/myrobotlab/service/Pir.java
Original file line number Diff line number Diff line change
Expand Up @@ -312,9 +312,8 @@ public Long getLastChangeTs() {
* "selecting" the controller's name, returns the possible list of pins to
* attach.
*
* @param pinArrayControl
* @return
* @throws InterruptedException
* @throws TimeoutException
*/
@SuppressWarnings("unchecked")
public List<PinDefinition> getPinList(String pinArrayControl) {
Expand Down
1 change: 0 additions & 1 deletion src/main/java/org/myrobotlab/service/Py4j.java
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,6 @@ public void stopService() {
*
* @param scriptName
* @param code
* @return
*/
public void updateScript(String scriptName, String code) {
if (openedScripts.containsKey(scriptName)) {
Expand Down
3 changes: 1 addition & 2 deletions src/main/java/org/myrobotlab/service/Python.java
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ public void closeScript(String file) {
/**
* append more Python to the current script
*
* @param data
* @param code
* the code to append
* @return the resulting concatenation
*/
Expand Down Expand Up @@ -759,7 +759,6 @@ public void saveScript(String scriptName, String code) throws IOException {
* upserts a script in memory
* @param file
* @param code
* @return
*/
public void updateScript(String file, String code) {
if (openedScripts.containsKey(file)) {
Expand Down
1 change: 0 additions & 1 deletion src/main/java/org/myrobotlab/service/Runtime.java
Original file line number Diff line number Diff line change
Expand Up @@ -2579,7 +2579,6 @@ public void addRoute(String remoteId, String uuid, int metric) {
*
* @param configName
* The name of the config file
* @return The Runtime singleton
*/
static public void startConfig(String configName) {
setConfig(configName);
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/myrobotlab/service/ServoMixer.java
Original file line number Diff line number Diff line change
Expand Up @@ -520,8 +520,8 @@ public void rest() {
*
* @param filename
* the filename to save the gesture as
* @param json
* the json to save
* @param gesture
* the gesture to save
*/
public void saveGesture(String filename, Gesture gesture) {
try {
Expand Down
18 changes: 0 additions & 18 deletions src/main/java/org/myrobotlab/service/_TemplateService.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,6 @@ public _TemplateService(String n, String id) {
super(n, id);
}

/**
* The methods apply and getConfig can be used, if more complex configuration handling is needed.
* By default, the framework takes care of most of it, including subscription handling.
* <pre>
@Override
public ServiceConfig apply(ServiceConfig c) {
super.apply(c)
return c;
}
@Override
public ServiceConfig getConfig() {
super.getConfig()
return config;
}
</pre>
**/

public static void main(String[] args) {
try {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ default void attachMotorController(MotorController controller) throws Exception
* the need of typed references
*
* @param controller
* @throws Exception
*/
default void detachMotorController(MotorController controller){
if (controller == null) {
Expand All @@ -81,7 +80,6 @@ default void detachMotorController(MotorController controller){
/**
* Implementation of detachMotorController
* @param controller
* @throws Exception
*/
void detachMotorController(String controller);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ public interface ServoControl extends AbsolutePositionControl, EncoderListener,
/**
* synchronizing servos together e.g. leftEye.sync("rightEye")
*
* @param servo
* @param name
* name that's being synched e.g. master.synch("slave")
*/
void sync(String name);
Expand Down

0 comments on commit 47133b9

Please sign in to comment.