diff --git a/.github/workflows/githubci.yml b/.github/workflows/githubci.yml index 9145985..849c5af 100644 --- a/.github/workflows/githubci.yml +++ b/.github/workflows/githubci.yml @@ -15,18 +15,47 @@ jobs: with: repository: adafruit/ci-arduino path: ci - + - name: pre-install run: bash ci/actions_install.sh - name: test platforms run: python3 ci/build_platform.py main_platforms + clang-format: + runs-on: ubuntu-latest + + steps: + - uses: actions/setup-python@v1 + with: + python-version: '3.x' + - uses: actions/checkout@v2 + - uses: actions/checkout@v2 + with: + repository: adafruit/ci-arduino + path: ci + + - name: pre-install + run: bash ci/actions_install.sh - name: clang run: python3 ci/run-clang-format.py -e "ci/*" -e "bin/*" -r . + doxygen: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - uses: actions/checkout@v2 + with: + repository: adafruit/ci-arduino + path: ci + + # The Adafruit doxygen setup is configured to only look for files in the root directory + - name: move src contents to root + run: mv -v src/* . - name: doxygen env: GH_REPO_TOKEN: ${{ secrets.GH_REPO_TOKEN }} PRETTYNAME : "Adafruit MCP23017 Library" run: bash ci/doxy_gen_and_deploy.sh + diff --git a/src/Adafruit_MCP23X08.cpp b/src/Adafruit_MCP23X08.cpp index a4d2ebf..eed7f57 100644 --- a/src/Adafruit_MCP23X08.cpp +++ b/src/Adafruit_MCP23X08.cpp @@ -1,23 +1,5 @@ /*! * @file Adafruit_MCP23X08.cpp - * - * @mainpage Adafruit MCP23X08/17 Library - * - * @section intro_sec Introduction - * - * This is a library for the MCP23008/17 I2C and MCP23S08/17 SPI port - * expanders. - * Adafruit invests time and resources providing this open source code, - * please support Adafruit and open-source hardware by purchasing - * products from Adafruit! - * - * @section author Author - * - * Written by Carter Nelson for Adafruit Industries. - * - * @section license License - * - * BSD license, all text above must be included in any redistribution */ #include "Adafruit_MCP23X08.h" diff --git a/src/Adafruit_MCP23X17.cpp b/src/Adafruit_MCP23X17.cpp index ed19b1f..cbf8c17 100644 --- a/src/Adafruit_MCP23X17.cpp +++ b/src/Adafruit_MCP23X17.cpp @@ -1,23 +1,5 @@ /*! * @file Adafruit_MCP23X17.cpp - * - * @mainpage Adafruit MCP23X08/17 Library - * - * @section intro_sec Introduction - * - * This is a library for the MCP23008/17 I2C and MCP23S08/17 SPI port - * expanders. - * Adafruit invests time and resources providing this open source code, - * please support Adafruit and open-source hardware by purchasing - * products from Adafruit! - * - * @section author Author - * - * Written by Carter Nelson for Adafruit Industries. - * - * @section license License - * - * BSD license, all text above must be included in any redistribution */ #include "Adafruit_MCP23X17.h" diff --git a/src/Adafruit_MCP23XXX.cpp b/src/Adafruit_MCP23XXX.cpp index 39724cb..3c1d7e3 100644 --- a/src/Adafruit_MCP23XXX.cpp +++ b/src/Adafruit_MCP23XXX.cpp @@ -144,7 +144,7 @@ void Adafruit_MCP23XXX::writeGPIO(uint8_t value, uint8_t port) { /*! @brief Configure the interrupt system. @param mirroring true to OR both INTA and INTB pins. - @param open true for open drain output, false for active drive output. + @param openDrain true for open drain output, false for active drive output. @param polarity HIGH or LOW */ /**************************************************************************/ @@ -247,6 +247,7 @@ uint8_t Adafruit_MCP23XXX::getLastInterruptPin() { @brief helper to get register address @param baseAddress base register address @param port 0 for A, 1 for B (MCP23X17 only) + @returns calculated register address */ /**************************************************************************/ uint16_t Adafruit_MCP23XXX::getRegister(uint8_t baseAddress, uint8_t port) {