Skip to content

Commit 2faa12d

Browse files
author
dherrada
committed
Revert "Fixed doxygen index page"
This reverts commit a7b90d4.
1 parent a7b90d4 commit 2faa12d

File tree

2 files changed

+30
-56
lines changed

2 files changed

+30
-56
lines changed

Adafruit_Fingerprint.cpp

Lines changed: 15 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,28 @@
1-
/*!
2-
* @file Adafruit_Fingerprint.cpp
3-
*
4-
* @mainpage Adafruit Fingerprint Sensor Library
5-
*
6-
* @section intro_sec Introduction
7-
*
8-
* This is a library for our optical Fingerprint sensor
9-
*
10-
* Designed specifically to work with the Adafruit Fingerprint sensor
11-
* ----> http://www.adafruit.com/products/751
12-
*
13-
* These displays use TTL Serial to communicate, 2 pins are required to
14-
* interface
15-
* Adafruit invests time and resources providing this open source code,
16-
* please support Adafruit and open-source hardware by purchasing
17-
* products from Adafruit!
18-
*
19-
* @section author Author
20-
*
21-
* Written by Limor Fried/Ladyada for Adafruit Industries.
22-
*
23-
* @section license License
24-
*
25-
* BSD license, all text above must be included in any redistribution
26-
*
27-
*/
1+
/***************************************************
2+
This is a library for our optical Fingerprint sensor
3+
4+
Designed specifically to work with the Adafruit Fingerprint sensor
5+
----> http://www.adafruit.com/products/751
6+
7+
These displays use TTL Serial to communicate, 2 pins are required to
8+
interface
9+
Adafruit invests time and resources providing this open source code,
10+
please support Adafruit and open-source hardware by purchasing
11+
products from Adafruit!
12+
13+
Written by Limor Fried/Ladyada for Adafruit Industries.
14+
BSD license, all text above must be included in any redistribution
15+
****************************************************/
2816

2917
#include "Adafruit_Fingerprint.h"
3018

3119
//#define FINGERPRINT_DEBUG
3220

33-
/// @cond DISABLE
3421
#if ARDUINO >= 100
35-
/// @endcond
36-
3722
#define SERIAL_WRITE(...) mySerial->write(__VA_ARGS__)
38-
/// @cond DISABLE
3923
#else
40-
/// @endcond
41-
4224
#define SERIAL_WRITE(...) mySerial->write(__VA_ARGS__, BYTE)
43-
/// @cond DISABLE
4425
#endif
45-
/// @endcond
4626

4727
#define SERIAL_WRITE_U16(v) \
4828
SERIAL_WRITE((uint8_t)(v >> 8)); \
@@ -66,9 +46,7 @@
6646
PUBLIC FUNCTIONS
6747
***************************************************************************/
6848

69-
/// @cond DISABLE
7049
#if defined(__AVR__) || defined(ESP8266) || defined(FREEDOM_E300_HIFIVE1)
71-
/// @endcond
7250
/**************************************************************************/
7351
/*!
7452
@brief Instantiates sensor with Software Serial
@@ -118,14 +96,10 @@ void Adafruit_Fingerprint::begin(uint32_t baudrate) {
11896

11997
if (hwSerial)
12098
hwSerial->begin(baudrate);
121-
/// @cond DISABLE
12299
#if defined(__AVR__) || defined(ESP8266) || defined(FREEDOM_E300_HIFIVE1)
123-
/// @endcond
124100
if (swSerial)
125101
swSerial->begin(baudrate);
126-
/// @cond DISABLE
127102
#endif
128-
/// @endcond
129103
}
130104

131105
/**************************************************************************/

Adafruit_Fingerprint.h

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,29 @@
11
#ifndef ADAFRUIT_FINGERPRINT_H
22
#define ADAFRUIT_FINGERPRINT_H
33

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

820
#include "Arduino.h"
9-
/// @cond DISABLE
1021
#if defined(__AVR__) || defined(ESP8266)
11-
/// @endcond
1222
#include <SoftwareSerial.h>
13-
/// @cond DISABLE
1423
#elif defined(FREEDOM_E300_HIFIVE1)
15-
/// @endcond
1624
#include <SoftwareSerial32.h>
1725
#define SoftwareSerial SoftwareSerial32
18-
/// @cond DISABLE
1926
#endif
20-
/// @endcond
2127

2228
#define FINGERPRINT_OK 0x00
2329
#define FINGERPRINT_PACKETRECIEVEERR 0x01
@@ -144,16 +150,10 @@ class Adafruit_Fingerprint {
144150
uint8_t recvPacket[20];
145151

146152
Stream *mySerial;
147-
/// @cond DISABLE
148153
#if defined(__AVR__) || defined(ESP8266) || defined(FREEDOM_E300_HIFIVE1)
149-
/// @endcond
150154
SoftwareSerial *swSerial;
151-
/// @cond DISABLE
152155
#endif
153-
/// @endcond
154156
HardwareSerial *hwSerial;
155157
};
156158

157-
/// @cond DISABLE
158159
#endif
159-
/// @endcond

0 commit comments

Comments
 (0)