Libraries: added help files to mitigate missing contextual reference issue

This commit is contained in:
Federico Fissore 2015-04-23 17:19:15 +02:00
parent 9a75cd3867
commit 5519f15663
29 changed files with 58 additions and 59 deletions

View File

@ -6,7 +6,7 @@
# Datatypes (KEYWORD1) # Datatypes (KEYWORD1)
####################################### #######################################
Audio KEYWORD1 Audio KEYWORD1 Audio
####################################### #######################################
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)

View File

@ -1,5 +1,5 @@
name=Audio name=Audio
version=1.0.1 version=1.0.2
author=Arduino author=Arduino
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Allows playing audio files from an SD card. For Arduino DUE only. sentence=Allows playing audio files from an SD card. For Arduino DUE only.

View File

@ -6,15 +6,15 @@
# Class (KEYWORD1) # Class (KEYWORD1)
####################################### #######################################
Bridge KEYWORD1 Bridge KEYWORD1 YunBridgeLibrary
FileIO KEYWORD4 FileIO KEYWORD4 YunFileIOConstructor
FileSystem KEYWORD1 FileSystem KEYWORD1 YunFileIOConstructor
Console KEYWORD1 Console KEYWORD1 YunConsoleConstructor
Process KEYWORD1 Process KEYWORD1 YunProcessConstructor
Mailbox KEYWORD1 Mailbox KEYWORD1 YunMailboxConstructor
HttpClient KEYWORD1 HttpClient KEYWORD1 YunHttpClientConstructor
YunServer KEYWORD1 YunServer KEYWORD1 YunServerConstructor
YunClient KEYWORD1 YunClient KEYWORD1 YunClientConstructor
####################################### #######################################
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)

View File

@ -1,5 +1,5 @@
name=Bridge name=Bridge
version=1.0.2 version=1.0.3
author=Arduino author=Arduino
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Enables the communication between the Linux processor and the AVR. For Arduino Yún and TRE only. sentence=Enables the communication between the Linux processor and the AVR. For Arduino Yún and TRE only.

View File

@ -4,7 +4,7 @@
# Class # Class
####################################### #######################################
Esplora KEYWORD1 Esplora KEYWORD1 EsploraLibrary
####################################### #######################################
# Methods and Functions # Methods and Functions

View File

@ -1,5 +1,5 @@
name=Esplora name=Esplora
version=1.0.2 version=1.0.3
author=Arduino author=Arduino
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Grants easy access to the various sensors and actuators of the Esplora. For Arduino Esplora only. sentence=Grants easy access to the various sensors and actuators of the Esplora. For Arduino Esplora only.

View File

@ -1 +0,0 @@
1.0.0

View File

@ -6,10 +6,10 @@
# Datatypes (KEYWORD1) # Datatypes (KEYWORD1)
####################################### #######################################
Ethernet KEYWORD1 Ethernet KEYWORD1 Ethernet
EthernetClient KEYWORD1 EthernetClient KEYWORD1 EthernetClient
EthernetServer KEYWORD1 EthernetServer KEYWORD1 EthernetServer
IPAddress KEYWORD1 IPAddress KEYWORD1 EthernetIPAddress
####################################### #######################################
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)

View File

@ -1,5 +1,5 @@
name=Ethernet name=Ethernet
version=1.0.1 version=1.0.2
author=Arduino author=Arduino
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Enables network connection (local and Internet) using the Arduino Ethernet board or shield. For all Arduino boards. sentence=Enables network connection (local and Internet) using the Arduino Ethernet board or shield. For all Arduino boards.

View File

@ -6,7 +6,7 @@
# Datatypes (KEYWORD1) # Datatypes (KEYWORD1)
####################################### #######################################
Firmata KEYWORD1 Firmata KEYWORD1 Firmata
callbackFunction KEYWORD1 callbackFunction KEYWORD1
systemResetCallbackFunction KEYWORD1 systemResetCallbackFunction KEYWORD1
stringCallbackFunction KEYWORD1 stringCallbackFunction KEYWORD1

View File

@ -1,5 +1,5 @@
name=Firmata name=Firmata
version=2.3.7 version=2.3.8
author=Firmata Developers author=Firmata Developers
maintainer=Firmata Developers <firmata-devel@lists.sourceforge.net> maintainer=Firmata Developers <firmata-devel@lists.sourceforge.net>
sentence=Enables the communication with computer apps using a standard serial protocol. For all Arduino boards. sentence=Enables the communication with computer apps using a standard serial protocol. For all Arduino boards.

View File

@ -4,16 +4,16 @@
# Class # Class
####################################### #######################################
GSM KEYWORD1 GSM KEYWORD1 GSM
GSMVoiceCall KEYWORD1 GSMVoiceCall KEYWORD1 GSMVCSConstructor
GSM_SMS KEYWORD1 GSM_SMS KEYWORD1 GSMSMSConstructor
GPRS KEYWORD1 GPRS KEYWORD1 GPRSConstructor
GSMClient KEYWORD1 GSMClient KEYWORD1 GSMClientConstructor
GSMServer KEYWORD1 GSMServer KEYWORD1 GSMServerConstructor
GSMModem KEYWORD1 GSMModem KEYWORD1 GSMModemConstructor
GSMScanner KEYWORD1 GSMScanner KEYWORD1 GSMScannerConstructor
GSMPIN KEYWORD1 GSMPIN KEYWORD1 GSMPINConstructor
GSMBand KEYWORD1 GSMBand KEYWORD1 GSMBandConstructor
####################################### #######################################
# Methods and Functions # Methods and Functions

View File

@ -1,5 +1,5 @@
name=GSM name=GSM
version=1.0.2 version=1.0.3
author=Arduino author=Arduino
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Enables GSM/GRPS network connection using the Arduino GSM Shield. For all Arduino boards BUT Arduino DUE. sentence=Enables GSM/GRPS network connection using the Arduino GSM Shield. For all Arduino boards BUT Arduino DUE.

View File

@ -6,7 +6,7 @@
# Datatypes (KEYWORD1) # Datatypes (KEYWORD1)
####################################### #######################################
LiquidCrystal KEYWORD1 LiquidCrystal KEYWORD1 LiquidCrystal
####################################### #######################################
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)

View File

@ -1,5 +1,5 @@
name=LiquidCrystal name=LiquidCrystal
version=1.0.0 version=1.0.1
author=Arduino, Adafruit author=Arduino, Adafruit
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Allows communication with alphanumerical liquid crystal displays (LCDs). For all Arduino boards. sentence=Allows communication with alphanumerical liquid crystal displays (LCDs). For all Arduino boards.

View File

@ -6,8 +6,8 @@
# Datatypes (KEYWORD1) # Datatypes (KEYWORD1)
####################################### #######################################
SD KEYWORD1 SD KEYWORD1 SD
File KEYWORD1 File KEYWORD1 SD
####################################### #######################################
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)

View File

@ -1,5 +1,5 @@
name=SD name=SD
version=1.0.3 version=1.0.4
author=Arduino, SparkFun author=Arduino, SparkFun
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Enables reading and writing on SD cards. For all Arduino boards. sentence=Enables reading and writing on SD cards. For all Arduino boards.

View File

@ -6,7 +6,7 @@
# Datatypes (KEYWORD1) # Datatypes (KEYWORD1)
####################################### #######################################
Scheduler KEYWORD1 Scheduler KEYWORD1 Scheduler
####################################### #######################################
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)

View File

@ -1,5 +1,5 @@
name=Scheduler name=Scheduler
version=0.4.1 version=0.4.2
author=Arduino author=Arduino
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Allows multiple tasks to run at the same time, without interrupting each other. For Arduino DUE only. sentence=Allows multiple tasks to run at the same time, without interrupting each other. For Arduino DUE only.

View File

@ -6,7 +6,7 @@
# Datatypes (KEYWORD1) # Datatypes (KEYWORD1)
####################################### #######################################
Servo KEYWORD1 Servo KEYWORD1 Servo
####################################### #######################################
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)

View File

@ -1,5 +1,5 @@
name=Servo name=Servo
version=1.0.1 version=1.0.2
author=Michael Margolis, Arduino author=Michael Margolis, Arduino
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Allows Arduino boards to control a variety of servo motors. For all Arduino boards. sentence=Allows Arduino boards to control a variety of servo motors. For all Arduino boards.

View File

@ -6,7 +6,7 @@
# Datatypes (KEYWORD1) # Datatypes (KEYWORD1)
####################################### #######################################
Stepper KEYWORD1 Stepper KEYWORD1 Stepper
####################################### #######################################
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)

View File

@ -1,5 +1,5 @@
name=Stepper name=Stepper
version=1.0.1 version=1.0.2
author=Arduino author=Arduino
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Allows Arduino boards to control a variety of stepper motors. For all Arduino boards. sentence=Allows Arduino boards to control a variety of stepper motors. For all Arduino boards.

View File

@ -6,7 +6,7 @@
# Datatypes (KEYWORD1) # Datatypes (KEYWORD1)
####################################### #######################################
TFT KEYWORD1 TFT KEYWORD1 TFTLibrary
####################################### #######################################
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)

View File

@ -1,5 +1,5 @@
name=TFT name=TFT
version=1.0.1 version=1.0.2
author=Arduino, Adafruit author=Arduino, Adafruit
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Allows drawing text, images, and shapes on the Arduino TFT graphical display. For all Arduino boards. sentence=Allows drawing text, images, and shapes on the Arduino TFT graphical display. For all Arduino boards.

View File

@ -6,15 +6,15 @@
# Datatypes (KEYWORD1) # Datatypes (KEYWORD1)
####################################### #######################################
MouseController KEYWORD1 MouseController KEYWORD1 MouseControllerConstructor
USBHost KEYWORD1 USBHost KEYWORD1 USBHost
KeyboardController KEYWORD1 KeyboardController KEYWORD1 KeyboardControllerConstructor
####################################### #######################################
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)
####################################### #######################################
Task KEYWORD2 Task KEYWORD2 USBHostTask
mouseMoved KEYWORD2 mouseMoved KEYWORD2
mouseDragged KEYWORD2 mouseDragged KEYWORD2
mousePressed KEYWORD2 mousePressed KEYWORD2

View File

@ -1,5 +1,5 @@
name=USBHost name=USBHost
version=1.0.1 version=1.0.2
author=Arduino author=Arduino
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Allows the communication with USB peripherals like mice, keyboards, and thumbdrives. For Arduino DUE only. sentence=Allows the communication with USB peripherals like mice, keyboards, and thumbdrives. For Arduino DUE only.

View File

@ -6,15 +6,15 @@
# Library (KEYWORD1) # Library (KEYWORD1)
####################################### #######################################
WiFi KEYWORD1 WiFi KEYWORD1 WiFi
WiFiUdp KEYWORD1 WiFiUdp KEYWORD1 WiFiUDPConstructor
####################################### #######################################
# Datatypes (KEYWORD1) # Datatypes (KEYWORD1)
####################################### #######################################
Client KEYWORD1 Client KEYWORD1 WiFiClientConstructor
Server KEYWORD1 Server KEYWORD1 WiFiServerConstructor
####################################### #######################################
# Methods and Functions (KEYWORD2) # Methods and Functions (KEYWORD2)
@ -43,9 +43,9 @@ RSSI KEYWORD2
encryptionType KEYWORD2 encryptionType KEYWORD2
getResult KEYWORD2 getResult KEYWORD2
getSocket KEYWORD2 getSocket KEYWORD2
WiFiClient KEYWORD2 WiFiClient KEYWORD2 WiFiClient
WiFiServer KEYWORD2 WiFiServer KEYWORD2 WiFiServer
WiFiUDP KEYWORD2 WiFiUDP KEYWORD2 WiFiUDPConstructor
beginPacket KEYWORD2 beginPacket KEYWORD2
endPacket KEYWORD2 endPacket KEYWORD2
parsePacket KEYWORD2 parsePacket KEYWORD2

View File

@ -1,5 +1,5 @@
name=WiFi name=WiFi
version=1.2.2 version=1.2.3
author=Arduino author=Arduino
maintainer=Arduino <info@arduino.cc> maintainer=Arduino <info@arduino.cc>
sentence=Enables network connection (local and Internet) using the Arduino WiFi shield. For all Arduino boards. sentence=Enables network connection (local and Internet) using the Arduino WiFi shield. For all Arduino boards.