From 5519f15663d408c4ddf6c28c27cd1945bbcd6b1c Mon Sep 17 00:00:00 2001 From: Federico Fissore Date: Thu, 23 Apr 2015 17:19:15 +0200 Subject: [PATCH] Libraries: added help files to mitigate missing contextual reference issue --- libraries/Audio/keywords.txt | 2 +- libraries/Audio/library.properties | 2 +- libraries/Bridge/keywords.txt | 18 +++++++++--------- libraries/Bridge/library.properties | 2 +- libraries/Esplora/keywords.txt | 2 +- libraries/Esplora/library.properties | 2 +- libraries/Ethernet/asd | 1 - libraries/Ethernet/keywords.txt | 8 ++++---- libraries/Ethernet/library.properties | 2 +- libraries/Firmata/keywords.txt | 2 +- libraries/Firmata/library.properties | 2 +- libraries/GSM/keywords.txt | 20 ++++++++++---------- libraries/GSM/library.properties | 2 +- libraries/LiquidCrystal/keywords.txt | 2 +- libraries/LiquidCrystal/library.properties | 2 +- libraries/SD/keywords.txt | 4 ++-- libraries/SD/library.properties | 2 +- libraries/Scheduler/keywords.txt | 2 +- libraries/Scheduler/library.properties | 2 +- libraries/Servo/keywords.txt | 2 +- libraries/Servo/library.properties | 2 +- libraries/Stepper/keywords.txt | 2 +- libraries/Stepper/library.properties | 2 +- libraries/TFT/keywords.txt | 2 +- libraries/TFT/library.properties | 2 +- libraries/USBHost/keywords.txt | 8 ++++---- libraries/USBHost/library.properties | 2 +- libraries/WiFi/keywords.txt | 14 +++++++------- libraries/WiFi/library.properties | 2 +- 29 files changed, 58 insertions(+), 59 deletions(-) delete mode 100644 libraries/Ethernet/asd diff --git a/libraries/Audio/keywords.txt b/libraries/Audio/keywords.txt index b95d21712..25cc67af6 100644 --- a/libraries/Audio/keywords.txt +++ b/libraries/Audio/keywords.txt @@ -6,7 +6,7 @@ # Datatypes (KEYWORD1) ####################################### -Audio KEYWORD1 +Audio KEYWORD1 Audio ####################################### # Methods and Functions (KEYWORD2) diff --git a/libraries/Audio/library.properties b/libraries/Audio/library.properties index f4f1cac35..3caa70522 100644 --- a/libraries/Audio/library.properties +++ b/libraries/Audio/library.properties @@ -1,5 +1,5 @@ name=Audio -version=1.0.1 +version=1.0.2 author=Arduino maintainer=Arduino sentence=Allows playing audio files from an SD card. For Arduino DUE only. diff --git a/libraries/Bridge/keywords.txt b/libraries/Bridge/keywords.txt index f5c1e8418..c96a8ed9c 100644 --- a/libraries/Bridge/keywords.txt +++ b/libraries/Bridge/keywords.txt @@ -6,15 +6,15 @@ # Class (KEYWORD1) ####################################### -Bridge KEYWORD1 -FileIO KEYWORD4 -FileSystem KEYWORD1 -Console KEYWORD1 -Process KEYWORD1 -Mailbox KEYWORD1 -HttpClient KEYWORD1 -YunServer KEYWORD1 -YunClient KEYWORD1 +Bridge KEYWORD1 YunBridgeLibrary +FileIO KEYWORD4 YunFileIOConstructor +FileSystem KEYWORD1 YunFileIOConstructor +Console KEYWORD1 YunConsoleConstructor +Process KEYWORD1 YunProcessConstructor +Mailbox KEYWORD1 YunMailboxConstructor +HttpClient KEYWORD1 YunHttpClientConstructor +YunServer KEYWORD1 YunServerConstructor +YunClient KEYWORD1 YunClientConstructor ####################################### # Methods and Functions (KEYWORD2) diff --git a/libraries/Bridge/library.properties b/libraries/Bridge/library.properties index 8ace1720a..320cb4436 100644 --- a/libraries/Bridge/library.properties +++ b/libraries/Bridge/library.properties @@ -1,5 +1,5 @@ name=Bridge -version=1.0.2 +version=1.0.3 author=Arduino maintainer=Arduino sentence=Enables the communication between the Linux processor and the AVR. For Arduino Yún and TRE only. diff --git a/libraries/Esplora/keywords.txt b/libraries/Esplora/keywords.txt index 42b79139e..afd5ecd1b 100644 --- a/libraries/Esplora/keywords.txt +++ b/libraries/Esplora/keywords.txt @@ -4,7 +4,7 @@ # Class ####################################### -Esplora KEYWORD1 +Esplora KEYWORD1 EsploraLibrary ####################################### # Methods and Functions diff --git a/libraries/Esplora/library.properties b/libraries/Esplora/library.properties index 30ef99c98..f54617f12 100644 --- a/libraries/Esplora/library.properties +++ b/libraries/Esplora/library.properties @@ -1,5 +1,5 @@ name=Esplora -version=1.0.2 +version=1.0.3 author=Arduino maintainer=Arduino sentence=Grants easy access to the various sensors and actuators of the Esplora. For Arduino Esplora only. diff --git a/libraries/Ethernet/asd b/libraries/Ethernet/asd deleted file mode 100644 index cbaf3b31a..000000000 --- a/libraries/Ethernet/asd +++ /dev/null @@ -1 +0,0 @@ -1.0.0 diff --git a/libraries/Ethernet/keywords.txt b/libraries/Ethernet/keywords.txt index 6b37cbe05..7b162a54b 100644 --- a/libraries/Ethernet/keywords.txt +++ b/libraries/Ethernet/keywords.txt @@ -6,10 +6,10 @@ # Datatypes (KEYWORD1) ####################################### -Ethernet KEYWORD1 -EthernetClient KEYWORD1 -EthernetServer KEYWORD1 -IPAddress KEYWORD1 +Ethernet KEYWORD1 Ethernet +EthernetClient KEYWORD1 EthernetClient +EthernetServer KEYWORD1 EthernetServer +IPAddress KEYWORD1 EthernetIPAddress ####################################### # Methods and Functions (KEYWORD2) diff --git a/libraries/Ethernet/library.properties b/libraries/Ethernet/library.properties index 0f61da904..1634bfea7 100644 --- a/libraries/Ethernet/library.properties +++ b/libraries/Ethernet/library.properties @@ -1,5 +1,5 @@ name=Ethernet -version=1.0.1 +version=1.0.2 author=Arduino maintainer=Arduino sentence=Enables network connection (local and Internet) using the Arduino Ethernet board or shield. For all Arduino boards. diff --git a/libraries/Firmata/keywords.txt b/libraries/Firmata/keywords.txt index 52e0a9c74..ca4522c3d 100644 --- a/libraries/Firmata/keywords.txt +++ b/libraries/Firmata/keywords.txt @@ -6,7 +6,7 @@ # Datatypes (KEYWORD1) ####################################### -Firmata KEYWORD1 +Firmata KEYWORD1 Firmata callbackFunction KEYWORD1 systemResetCallbackFunction KEYWORD1 stringCallbackFunction KEYWORD1 diff --git a/libraries/Firmata/library.properties b/libraries/Firmata/library.properties index e2237251e..4b508d57c 100644 --- a/libraries/Firmata/library.properties +++ b/libraries/Firmata/library.properties @@ -1,5 +1,5 @@ name=Firmata -version=2.3.7 +version=2.3.8 author=Firmata Developers maintainer=Firmata Developers sentence=Enables the communication with computer apps using a standard serial protocol. For all Arduino boards. diff --git a/libraries/GSM/keywords.txt b/libraries/GSM/keywords.txt index e55e6e2c6..4a44464ad 100644 --- a/libraries/GSM/keywords.txt +++ b/libraries/GSM/keywords.txt @@ -4,16 +4,16 @@ # Class ####################################### -GSM KEYWORD1 -GSMVoiceCall KEYWORD1 -GSM_SMS KEYWORD1 -GPRS KEYWORD1 -GSMClient KEYWORD1 -GSMServer KEYWORD1 -GSMModem KEYWORD1 -GSMScanner KEYWORD1 -GSMPIN KEYWORD1 -GSMBand KEYWORD1 +GSM KEYWORD1 GSM +GSMVoiceCall KEYWORD1 GSMVCSConstructor +GSM_SMS KEYWORD1 GSMSMSConstructor +GPRS KEYWORD1 GPRSConstructor +GSMClient KEYWORD1 GSMClientConstructor +GSMServer KEYWORD1 GSMServerConstructor +GSMModem KEYWORD1 GSMModemConstructor +GSMScanner KEYWORD1 GSMScannerConstructor +GSMPIN KEYWORD1 GSMPINConstructor +GSMBand KEYWORD1 GSMBandConstructor ####################################### # Methods and Functions diff --git a/libraries/GSM/library.properties b/libraries/GSM/library.properties index 13de63a5f..8c81c5d7f 100644 --- a/libraries/GSM/library.properties +++ b/libraries/GSM/library.properties @@ -1,5 +1,5 @@ name=GSM -version=1.0.2 +version=1.0.3 author=Arduino maintainer=Arduino sentence=Enables GSM/GRPS network connection using the Arduino GSM Shield. For all Arduino boards BUT Arduino DUE. diff --git a/libraries/LiquidCrystal/keywords.txt b/libraries/LiquidCrystal/keywords.txt index 4ee24d90d..b6aa7fd90 100644 --- a/libraries/LiquidCrystal/keywords.txt +++ b/libraries/LiquidCrystal/keywords.txt @@ -6,7 +6,7 @@ # Datatypes (KEYWORD1) ####################################### -LiquidCrystal KEYWORD1 +LiquidCrystal KEYWORD1 LiquidCrystal ####################################### # Methods and Functions (KEYWORD2) diff --git a/libraries/LiquidCrystal/library.properties b/libraries/LiquidCrystal/library.properties index 37764b2d7..f379f78cc 100644 --- a/libraries/LiquidCrystal/library.properties +++ b/libraries/LiquidCrystal/library.properties @@ -1,5 +1,5 @@ name=LiquidCrystal -version=1.0.0 +version=1.0.1 author=Arduino, Adafruit maintainer=Arduino sentence=Allows communication with alphanumerical liquid crystal displays (LCDs). For all Arduino boards. diff --git a/libraries/SD/keywords.txt b/libraries/SD/keywords.txt index 419fe04d5..9893cc91d 100644 --- a/libraries/SD/keywords.txt +++ b/libraries/SD/keywords.txt @@ -6,8 +6,8 @@ # Datatypes (KEYWORD1) ####################################### -SD KEYWORD1 -File KEYWORD1 +SD KEYWORD1 SD +File KEYWORD1 SD ####################################### # Methods and Functions (KEYWORD2) diff --git a/libraries/SD/library.properties b/libraries/SD/library.properties index 2cbf9f82a..4658054f8 100644 --- a/libraries/SD/library.properties +++ b/libraries/SD/library.properties @@ -1,5 +1,5 @@ name=SD -version=1.0.3 +version=1.0.4 author=Arduino, SparkFun maintainer=Arduino sentence=Enables reading and writing on SD cards. For all Arduino boards. diff --git a/libraries/Scheduler/keywords.txt b/libraries/Scheduler/keywords.txt index 87313b8fc..6134de2b9 100644 --- a/libraries/Scheduler/keywords.txt +++ b/libraries/Scheduler/keywords.txt @@ -6,7 +6,7 @@ # Datatypes (KEYWORD1) ####################################### -Scheduler KEYWORD1 +Scheduler KEYWORD1 Scheduler ####################################### # Methods and Functions (KEYWORD2) diff --git a/libraries/Scheduler/library.properties b/libraries/Scheduler/library.properties index 9ab605bc7..241208ce7 100644 --- a/libraries/Scheduler/library.properties +++ b/libraries/Scheduler/library.properties @@ -1,5 +1,5 @@ name=Scheduler -version=0.4.1 +version=0.4.2 author=Arduino maintainer=Arduino sentence=Allows multiple tasks to run at the same time, without interrupting each other. For Arduino DUE only. diff --git a/libraries/Servo/keywords.txt b/libraries/Servo/keywords.txt index ca5ba79e3..0a7ca1e3d 100644 --- a/libraries/Servo/keywords.txt +++ b/libraries/Servo/keywords.txt @@ -6,7 +6,7 @@ # Datatypes (KEYWORD1) ####################################### -Servo KEYWORD1 +Servo KEYWORD1 Servo ####################################### # Methods and Functions (KEYWORD2) diff --git a/libraries/Servo/library.properties b/libraries/Servo/library.properties index eb244756c..1712ac80f 100644 --- a/libraries/Servo/library.properties +++ b/libraries/Servo/library.properties @@ -1,5 +1,5 @@ name=Servo -version=1.0.1 +version=1.0.2 author=Michael Margolis, Arduino maintainer=Arduino sentence=Allows Arduino boards to control a variety of servo motors. For all Arduino boards. diff --git a/libraries/Stepper/keywords.txt b/libraries/Stepper/keywords.txt index 19a0fadf2..5e58a66b0 100644 --- a/libraries/Stepper/keywords.txt +++ b/libraries/Stepper/keywords.txt @@ -6,7 +6,7 @@ # Datatypes (KEYWORD1) ####################################### -Stepper KEYWORD1 +Stepper KEYWORD1 Stepper ####################################### # Methods and Functions (KEYWORD2) diff --git a/libraries/Stepper/library.properties b/libraries/Stepper/library.properties index 4b0af1134..f17170344 100644 --- a/libraries/Stepper/library.properties +++ b/libraries/Stepper/library.properties @@ -1,5 +1,5 @@ name=Stepper -version=1.0.1 +version=1.0.2 author=Arduino maintainer=Arduino sentence=Allows Arduino boards to control a variety of stepper motors. For all Arduino boards. diff --git a/libraries/TFT/keywords.txt b/libraries/TFT/keywords.txt index 0ddb3b536..c8d33e416 100644 --- a/libraries/TFT/keywords.txt +++ b/libraries/TFT/keywords.txt @@ -6,7 +6,7 @@ # Datatypes (KEYWORD1) ####################################### -TFT KEYWORD1 +TFT KEYWORD1 TFTLibrary ####################################### # Methods and Functions (KEYWORD2) diff --git a/libraries/TFT/library.properties b/libraries/TFT/library.properties index 382de6c56..a46758741 100644 --- a/libraries/TFT/library.properties +++ b/libraries/TFT/library.properties @@ -1,5 +1,5 @@ name=TFT -version=1.0.1 +version=1.0.2 author=Arduino, Adafruit maintainer=Arduino sentence=Allows drawing text, images, and shapes on the Arduino TFT graphical display. For all Arduino boards. diff --git a/libraries/USBHost/keywords.txt b/libraries/USBHost/keywords.txt index dded4dcf7..1ace20256 100644 --- a/libraries/USBHost/keywords.txt +++ b/libraries/USBHost/keywords.txt @@ -6,15 +6,15 @@ # Datatypes (KEYWORD1) ####################################### -MouseController KEYWORD1 -USBHost KEYWORD1 -KeyboardController KEYWORD1 +MouseController KEYWORD1 MouseControllerConstructor +USBHost KEYWORD1 USBHost +KeyboardController KEYWORD1 KeyboardControllerConstructor ####################################### # Methods and Functions (KEYWORD2) ####################################### -Task KEYWORD2 +Task KEYWORD2 USBHostTask mouseMoved KEYWORD2 mouseDragged KEYWORD2 mousePressed KEYWORD2 diff --git a/libraries/USBHost/library.properties b/libraries/USBHost/library.properties index 7cc5abc42..765a0d6fe 100644 --- a/libraries/USBHost/library.properties +++ b/libraries/USBHost/library.properties @@ -1,5 +1,5 @@ name=USBHost -version=1.0.1 +version=1.0.2 author=Arduino maintainer=Arduino sentence=Allows the communication with USB peripherals like mice, keyboards, and thumbdrives. For Arduino DUE only. diff --git a/libraries/WiFi/keywords.txt b/libraries/WiFi/keywords.txt index 641c67a7d..341114d95 100644 --- a/libraries/WiFi/keywords.txt +++ b/libraries/WiFi/keywords.txt @@ -6,15 +6,15 @@ # Library (KEYWORD1) ####################################### -WiFi KEYWORD1 -WiFiUdp KEYWORD1 +WiFi KEYWORD1 WiFi +WiFiUdp KEYWORD1 WiFiUDPConstructor ####################################### # Datatypes (KEYWORD1) ####################################### -Client KEYWORD1 -Server KEYWORD1 +Client KEYWORD1 WiFiClientConstructor +Server KEYWORD1 WiFiServerConstructor ####################################### # Methods and Functions (KEYWORD2) @@ -43,9 +43,9 @@ RSSI KEYWORD2 encryptionType KEYWORD2 getResult KEYWORD2 getSocket KEYWORD2 -WiFiClient KEYWORD2 -WiFiServer KEYWORD2 -WiFiUDP KEYWORD2 +WiFiClient KEYWORD2 WiFiClient +WiFiServer KEYWORD2 WiFiServer +WiFiUDP KEYWORD2 WiFiUDPConstructor beginPacket KEYWORD2 endPacket KEYWORD2 parsePacket KEYWORD2 diff --git a/libraries/WiFi/library.properties b/libraries/WiFi/library.properties index 7f95cda2c..59ef37d5e 100644 --- a/libraries/WiFi/library.properties +++ b/libraries/WiFi/library.properties @@ -1,5 +1,5 @@ name=WiFi -version=1.2.2 +version=1.2.3 author=Arduino maintainer=Arduino sentence=Enables network connection (local and Internet) using the Arduino WiFi shield. For all Arduino boards.