Doxygen version.

Use LED_BUILTIN instead of FEEDBACK_LED FeedbackLEDPin is 0. Use F_CPU instead of SYSCLOCK. Remove IRBoardDefs.h and outdated readmdFrench.md.

Author: ArminJo

.github/issue_template.md

@@ -49,6 +49,8 @@ Please delete all unchecked lines above :-)
 
 ### Pin(s) used for IR-receive, if not default
 
+[Use code blocks](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code); **it helps us help you when we can read your code!**
+Please also refrain from pasting more than 50 lines of code in a post, instead **[create a gist](https://gist.github.com/) if you need to share large snippets**
 **Code Block:**
 ```
 
@@ -58,7 +60,6 @@ Please delete all unchecked lines above :-)
 
 ```
 
-Use [a gist](gist.github.com) if the code exceeds 30 lines
 
 ### Current behavior
 <!-- Paste the code or repository link, if applicable. -->

Contributing.md

@@ -1,13 +1,13 @@
 # Contribution Guidelines
 
-This library is the culmination of the expertise of many members of the open source community who have dedicated their time and hard work. The best way to ask for help or propose a new idea is to [create a new issue](https://github.com/z3t0/Arduino-IRremote/issues/new) while creating a Pull Request with your code changes allows you to share your own innovations with the rest of the community.
+This library is the culmination of the expertise of many members of the open source community who have dedicated their time and hard work.
+The best way to ask for help or propose a new idea is to create a new discussion and / or a new Pull Request
+with your code changes to allow you to share your own innovations with the rest of the community.
 
-The following are some guidelines to observe when creating issues or PRs:
-- Be friendly; it is important that we can all enjoy a safe space as we are all working on the same project and it is okay for people to have different ideas
-- [Use code blocks](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code); **it helps us help you when we can read your code!** On that note also refrain from pasting more than 30 lines of code in a post, instead **[create a gist](https://gist.github.com/) if you need to share large snippets**
-- Use reasonable titles; refrain from using overly long or capitalized titles as they are usually annoying and do little to encourage others to help :smile:
-- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library
-- Use the style; we use the original [C Style by Kerninghan / Ritchie](https://en.wikipedia.org/wiki/Indentation_style#K&R_style) in [variant: 1TBS (OTBS)](https://en.wikipedia.org/wiki/Indentation_style#Variant:_1TBS_(OTBS)). In short: 4 spaces indentation, no tabs, opening braces on the same line, braces are mandatory on all if/while/do, no hard line length limit. To beautify your code, you may use the online formatter [here](https://www.freecodeformat.com/c-format.php).
-- Choose the right Pull Request target; if you only have **minor changes or adding a new protocol**, choose **master** as target for your Pull Request. If have a change **addressing more general aspects** of this library or think, that the PR should be **discussed and reviewed**, choose the **dev** branch as target for your Pull Request like described [here](https://guides.github.com/introduction/flow/).
-
-If there is any need to contact me then you can find my email on the README, I do not mind responding to emails but it would be in your own interests to create issues if you need help with the library as responses would be from a larger community with greater knowledge!
+The following are some guidelines to observe when creating discussions / PRs:
+- Be friendly; it is important that we can all enjoy a safe space as we are all working on the same project and **it is okay for people to have different ideas**.
+- Use reasonable titles; refrain from using overly long or capitalized titles as they are usually annoying and do little to encourage others to help :smile:.
+- Use the style; we use the original [C Style by Kerninghan / Ritchie](https://en.wikipedia.org/wiki/Indentation_style#K&R_style) in [variant: 1TBS (OTBS)](https://en.wikipedia.org/wiki/Indentation_style#Variant:_1TBS_(OTBS)).
+ In short: 4 spaces indentation, no tabs, opening braces on the same line, braces are mandatory on all if/while/do, no hard line length limit.
+ To beautify your code, you may use the online formatter [here](https://www.freecodeformat.com/c-format.php).
+- Cover **all** occurences of the problem / addition you address with your PR. Do not forget the documentation like it is done for existing code. Code changes without proper documentation will be rejected!

Doxyfile

@@ -58,7 +58,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       =
+OUTPUT_DIRECTORY       = ..\Arduino-IRremote_gh-pages
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
 # directories (in 2 levels) under the output directory of each output format and
@@ -815,7 +815,6 @@ WARN_LOGFILE           =
 
 INPUT                  = src \
                          src/private \
-                         examples/MicroGirs \
                          .
 
 # This tag can be used to specify the character encoding of the source files
@@ -1064,7 +1063,7 @@ VERBATIM_HEADERS       = YES
 # classes, structs, unions or interfaces.
 # The default value is: YES.
 
-ALPHABETICAL_INDEX     = YES
+ALPHABETICAL_INDEX     = NO
 
 # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
 # which the alphabetical index list will be split.
@@ -1096,8 +1095,6 @@ GENERATE_HTML          = YES
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-# This name is selected to be able to easily publish with GitHub's gh-pages.
-
 HTML_OUTPUT            = docs
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
@@ -1457,7 +1454,7 @@ DISABLE_INDEX          = NO
 # The default value is: NO.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = YES
 
 # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
 # doxygen will group on one line in the generated HTML documentation.

README.md

@@ -11,7 +11,8 @@ Available as Arduino library "IRremote"
 
 This library enables you to send and receive using infra-red signals on an Arduino.
 
-Tutorials and more information will be made available on [the official homepage](https://arduino-irremote.github.io/Arduino-IRremote/).
+# API
+A Doxygen documentation of the sources is available on [project homepage](https://arduino-irremote.github.io/Arduino-IRremote/).
 
 # Installation
 Click on the LibraryManager badge above to see the [instructions](https://www.ardu-badge.com/IRremote/zip).
@@ -122,10 +123,10 @@ Modify it by commenting them out or in, or change the values if applicable. Or d
 | `FEEDBACK_LED_IS_ACTIVE_LOW` | Before `#include <IRremote.h>` | disabled | Required on some boards (like my BluePill and my ESP8266 board), where the feedback LED is active low. |
 | `DISABLE_LED_FEEDBACK_FOR_RECEIVE` | Before `#include <IRremote.h>` | disabled | This disables the LED feedback code for receive, thus saving around 108 bytes program space and halving the receiver ISR processing time. |
 | `IR_INPUT_IS_ACTIVE_HIGH` | Before `#include <IRremote.h>` | disabled | Enable it if you use a RF receiver, which has an active HIGH output signal. |
-| `RAW_BUFFER_LENGTH` | IRremoteint.h | 101 | Buffer size of raw input buffer. Must be odd! |
+| `RAW_BUFFER_LENGTH` | IRremoteInt.h | 101 | Buffer size of raw input buffer. Must be odd! |
 | `DEBUG` | IRremoteInt.h | disabled | Enables lots of lovely debug output. |
-| `IR_SEND_DUTY_CYCLE` | IRremoteint.h | 30 | Duty cycle of IR send signal. |
-| `MICROS_PER_TICK` | IRremoteint.h | 50 | Resolution of the raw input buffer data. |
+| `IR_SEND_DUTY_CYCLE` | IRremoteInt.h | 30 | Duty cycle of IR send signal. |
+| `MICROS_PER_TICK` | IRremoteInt.h | 50 | Resolution of the raw input buffer data. |
 |-|-|-|-|
 | `IR_INPUT_PIN` | TinyIRReceiver.h | 2 | The pin number for TinyIRReceiver IR input, which gets compiled in. |
 | `IR_FEEDBACK_LED_PIN` | TinyIRReceiver.h | `LED_BUILTIN` | The pin number for TinyIRReceiver feedback LED, which gets compiled in. |
@@ -143,7 +144,7 @@ If you are using Sloeber as your IDE, you can easily define global symbols with
 
 # Supported Boards
 - Arduino Uno / Mega / Leonardo / Duemilanove / Diecimila / LilyPad / Mini / Fio / Nano etc.
-- Teensy 1.0 / 1.0++ / 2.0 / 2++ / 3.0 / 3.1 / Teensy-LC; Credits: @PaulStoffregen (Teensy Team)
+- Teensy 1.0 / 1.0++ / 2.0 / 2++ / 3.0 / 3.1 / Teensy-LC; Credits: PaulStoffregen (Teensy Team)
 - Sanguino
 - ATmega8, 48, 88, 168, 328
 - ATmega8535, 16, 32, 164, 324, 644, 1284,
@@ -221,13 +222,11 @@ See [API reference in wiki](https://github.com/Arduino-IRremote/Arduino-IRremote
 
 To generate the API documentation,
 Doxygen, as well as [Graphviz](http://www.graphviz.org/) should be installed.
-(Note that on Windows, it may be necessary to add the Graphviz binary directory
-(something like `C:\Program Files\Graphviz2.38\bin`)
-to the `PATH` variable manually.)
+(Note that on Windows, it is useful to specify the installer to add Graphviz to PATH or to do it manually.
 With Doxygen and Graphviz installed, issue the command
 `doxygen` from the command line in the main project directory, which will
 generate the API documentation in HTML format.
-The just generated `api-doc/index.html` can now be opened in a browser.
+The just generated `docs/index.html` can now be opened in a browser.
 
 ## Why do we use 33% duty cycle
 We do it according to the statement in the [Vishay datasheet](https://www.vishay.com/docs/80069/circuit.pdf):

changelog.md

@@ -1,5 +1,8 @@
+# Changelog
+The latest version may not be released!
+
 ## 3.1.0
-- Replaced #define DECODE_NEC 1/0 by defining/not defining.
+- Replaced `#define DECODE_NEC 1/0` by defining/not defining.
 - USE_SOFT_SEND_PWM is active by default.
 - Refactored Board specific code.
 - Separated timer and feedback LED related code.
@@ -12,6 +15,8 @@
 - Added unit test and fixed LG send bug.
 - MATCH_MARK() etc. now available as matchMark().
 - Added ATtiny88 support.
+- Use LED_BUILTIN instead of FEEDBACK_LED FeedbackLEDPin is 0.
+- Use F_CPU instead of SYSCLOCK.
 
 ## 3.0.2
 - Bug fix for USE_OLD_DECODE.
@@ -80,7 +85,7 @@
 - NEC repeat implementation.
 - Formatting and changing `TIMER_CONFIG_KHZ` and `TIMER_CONFIG_NORMAL` macros to static functions.
 - Added `IRAM_ATTR` for ESP32 ISR.
-- Removed #define `HAS_AVR_INTERRUPT_H`.
+- Removed `#define HAS_AVR_INTERRUPT_H`.
 - Changed Receiver States. Now starting with 0.
 - Changed switch to if / else if in IRRemote.cpp because of ESP32 compiler bug.
 - Changed `DEBUG` handling since compiler warns about empty "IF" or "ELSE" statements in IRRemote.cpp.
@@ -99,7 +104,7 @@
 Changes from #283 by bengtmartensson
 - Added function sendRaw_P() for sending data from flash.
 Changes from #268 by adamlhumphreys
-- Optimized by reducing floating point operations as suggested by @madmalkav (#193).
+- Optimized by reducing floating point operations as suggested by madmalkav (#193).
 - Optimized with macros when using default `MICROS_PER_TICK` and `TOLERANCE`.
 - Made decodeHash as a settable protocol defined by `DECODE_HASH`.
 - Added Philips Extended RC-5 protocol support [PR #522] (https://github.com/Arduino-IRremote/Arduino-IRremote/pull/522)
@@ -165,7 +170,7 @@ Changes from #268 by adamlhumphreys
 - Fixed and Improved many coding errors
 - Fixed Aiwa RC-T501 Decoding
 - Fixed Interrupt on ATmega8
-- Switched to Stable Release of @PlatformIO
+- Switched to Stable Release of PlatformIO
 
 ### Additions
 - Added Aiwa RC-T501 Protocol

examples/IRremoteInfo/IRremoteInfo.ino

@@ -105,7 +105,7 @@ void dumpTimerPin() {
 
 void dumpClock() {
     Serial.print(F("MCU Clock: "));
-    Serial.println(SYSCLOCK);
+    Serial.println(F_CPU);
 }
 
 void dumpPlatform() {