Skip to content

Commit

Permalink
Revert "Fixed doxygen index page"
Browse files Browse the repository at this point in the history
This reverts commit a7b90d4.
  • Loading branch information
dherrada committed May 20, 2020
1 parent a7b90d4 commit 2faa12d
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 56 deletions.
56 changes: 15 additions & 41 deletions Adafruit_Fingerprint.cpp
Original file line number Diff line number Diff line change
@@ -1,48 +1,28 @@
/*!
* @file Adafruit_Fingerprint.cpp
*
* @mainpage Adafruit Fingerprint Sensor Library
*
* @section intro_sec Introduction
*
* This is a library for our optical Fingerprint sensor
*
* Designed specifically to work with the Adafruit Fingerprint sensor
* ----> http://www.adafruit.com/products/751
*
* These displays use TTL Serial to communicate, 2 pins are required to
* interface
* 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 Limor Fried/Ladyada for Adafruit Industries.
*
* @section license License
*
* BSD license, all text above must be included in any redistribution
*
*/
/***************************************************
This is a library for our optical Fingerprint sensor
Designed specifically to work with the Adafruit Fingerprint sensor
----> http://www.adafruit.com/products/751
These displays use TTL Serial to communicate, 2 pins are required to
interface
Adafruit invests time and resources providing this open source code,
please support Adafruit and open-source hardware by purchasing
products from Adafruit!
Written by Limor Fried/Ladyada for Adafruit Industries.
BSD license, all text above must be included in any redistribution
****************************************************/

#include "Adafruit_Fingerprint.h"

//#define FINGERPRINT_DEBUG

/// @cond DISABLE
#if ARDUINO >= 100
/// @endcond

#define SERIAL_WRITE(...) mySerial->write(__VA_ARGS__)
/// @cond DISABLE
#else
/// @endcond

#define SERIAL_WRITE(...) mySerial->write(__VA_ARGS__, BYTE)
/// @cond DISABLE
#endif
/// @endcond

#define SERIAL_WRITE_U16(v) \
SERIAL_WRITE((uint8_t)(v >> 8)); \
Expand All @@ -66,9 +46,7 @@
PUBLIC FUNCTIONS
***************************************************************************/

/// @cond DISABLE
#if defined(__AVR__) || defined(ESP8266) || defined(FREEDOM_E300_HIFIVE1)
/// @endcond
/**************************************************************************/
/*!
@brief Instantiates sensor with Software Serial
Expand Down Expand Up @@ -118,14 +96,10 @@ void Adafruit_Fingerprint::begin(uint32_t baudrate) {

if (hwSerial)
hwSerial->begin(baudrate);
/// @cond DISABLE
#if defined(__AVR__) || defined(ESP8266) || defined(FREEDOM_E300_HIFIVE1)
/// @endcond
if (swSerial)
swSerial->begin(baudrate);
/// @cond DISABLE
#endif
/// @endcond
}

/**************************************************************************/
Expand Down
30 changes: 15 additions & 15 deletions Adafruit_Fingerprint.h
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@
#ifndef ADAFRUIT_FINGERPRINT_H
#define ADAFRUIT_FINGERPRINT_H

/*!
* @file Adafruit_Fingerprint.h
*/
/***************************************************
This is a library for our optical Fingerprint sensor
Designed specifically to work with the Adafruit Fingerprint sensor
----> http://www.adafruit.com/products/751
These displays use TTL Serial to communicate, 2 pins are required to
interface
Adafruit invests time and resources providing this open source code,
please support Adafruit and open-source hardware by purchasing
products from Adafruit!
Written by Limor Fried/Ladyada for Adafruit Industries.
BSD license, all text above must be included in any redistribution
****************************************************/

#include "Arduino.h"
/// @cond DISABLE
#if defined(__AVR__) || defined(ESP8266)
/// @endcond
#include <SoftwareSerial.h>
/// @cond DISABLE
#elif defined(FREEDOM_E300_HIFIVE1)
/// @endcond
#include <SoftwareSerial32.h>
#define SoftwareSerial SoftwareSerial32
/// @cond DISABLE
#endif
/// @endcond

#define FINGERPRINT_OK 0x00
#define FINGERPRINT_PACKETRECIEVEERR 0x01
Expand Down Expand Up @@ -144,16 +150,10 @@ class Adafruit_Fingerprint {
uint8_t recvPacket[20];

Stream *mySerial;
/// @cond DISABLE
#if defined(__AVR__) || defined(ESP8266) || defined(FREEDOM_E300_HIFIVE1)
/// @endcond
SoftwareSerial *swSerial;
/// @cond DISABLE
#endif
/// @endcond
HardwareSerial *hwSerial;
};

/// @cond DISABLE
#endif
/// @endcond

0 comments on commit 2faa12d

Please sign in to comment.