Added DoxyGen

This commit is contained in:
jgromes 2019-05-24 15:13:04 +02:00
parent 7381ae6176
commit b9a1847f90
4 changed files with 2641 additions and 3 deletions

View file

@ -6,15 +6,24 @@ env:
- BOARD="arduino:avr:uno"
- BOARD="arduino:avr:leonardo"
- BOARD="arduino:avr:mega:cpu=atmega2560"
before_install:
# install Arduino IDE
- wget http://downloads.arduino.cc/arduino-$ARDUINO_IDE_VERSION-linux64.tar.xz
- tar xf arduino-$ARDUINO_IDE_VERSION-linux64.tar.xz
- mv arduino-$ARDUINO_IDE_VERSION $HOME/arduino-ide
- export PATH=$PATH:$HOME/arduino-ide
# create directory to save the library and create symbolic link
install:
- mkdir -p $HOME/Arduino/libraries
- ln -s $PWD $HOME/Arduino/libraries/RadioLib
# only build the master branch
branches:
only:
- master
script:
# build all example sketches
- for example in $(find $PWD/examples -name '*.ino' | sort); do
@ -27,3 +36,20 @@ script:
echo -e "\033[1;32m${example##*/} build PASSED\033[0m\n";
fi
done
# generate Doxygen documentation (only for Arduino UNO)
- if [ $BOARD = "arduino:avr:uno" ]; then
sudo apt-get update;
sudo apt-get install -y doxygen;
cd ..;
doxygen Doxyfile;
fi
# deploy Doxygen docs on master branch and only when building for Arduino UNO
deploy:
provider: pages
skip_cleanup: true
local_dir: docs/html
github_token: $GH_REPO_TOKEN
on:
branch: master
condition: $BOARD = "arduino:avr:uno"

2565
Doxyfile Normal file

File diff suppressed because it is too large Load diff

View file

@ -1,7 +1,7 @@
name=RadioLib
version=1.0.0
author=Jan Gromes <gipsonek@gmail.com>
maintainer=Jan Gromes <gipsonek@gmail.com>
author=Jan Gromes <gromes.jan@gmail.com>
maintainer=Jan Gromes <gromes.jan@gmail.com>
sentence=Universal wireless communication library for Arduino
paragraph=Enables user-friendly control of the RadioShield and various wireless modules.
category=Communication

View file

@ -1,6 +1,40 @@
#ifndef _RADIOLIB_H
#define _RADIOLIB_H
/*!
\mainpage RadioLib Documentation
Universal wireless communication library for Arduino.
\par Currently Supported Wireless Modules and Protocols
- CC1101 FSK module
- HC05 Bluetooth module
- JDY08 BLE module
- RF69 FSK module
- SX126x LoRa/FSK module
- SX127x LoRa/FSK module
- SX1231 FSK module
- XBee module (S2B)
- PhysicalLayer protocols
- RTTY
- Morse Code
- TransportLayer protocols
- HTTP
- MQTT
\par Quick Links
Documentation for most common methods can be found in its reference page (see the list above).\n
Some methods (mainly configuration) are also overridden in derived classes, such as SX1272, SX1278, RFM96 etc. for SX127x.\n
\ref status_codes have their own page.\n
Some modules implement methods of one or more compatibility layers, loosely based on the ISO/OSI model.
- PhysicalLayer - FSK and LoRa radio modules
- TransportLayer - Modules with Internet connectivity
\see https://github.com/jgromes/RadioLib
\copyright Copyright (c) 2019 Jan Gromes
*/
#include "TypeDef.h"
#include "Module.h"
@ -24,14 +58,17 @@
#include "modules/SX1279.h"
#include "modules/XBee.h"
// physical layer protocols
#include "protocols/PhysicalLayer.h"
#include "protocols/Morse.h"
#include "protocols/RTTY.h"
// transport layer protocols
#include "protocols/TransportLayer.h"
#include "protocols/HTTP.h"
#include "protocols/MQTT.h"
// RadioShield pin definitions
#define RADIOSHIELD_CS_A 10
#define RADIOSHIELD_RX_A 9
#define RADIOSHIELD_TX_A 8
@ -41,8 +78,19 @@
#define RADIOSHIELD_INT_0 2
#define RADIOSHIELD_INT_1 3
/*!
\class Radio
\brief Library control object when using RadioShield.
Contains two pre-configured "modules", which correspond to the slots on shield.
*/
class Radio {
public:
/*!
\brief Default constructor. Only used to preconfigure ModuleA and ModuleB.
*/
Radio();
Module* ModuleA;
@ -50,7 +98,6 @@ class Radio {
private:
};
extern Radio RadioShield;