Update Doxygen documentation for v1.2.0

- Update doxygen.cfg: version 1.1.1->1.2.0, project name/brief,
  enable USE_MDFILE_AS_MAINPAGE, OPTIMIZE_OUTPUT_FOR_C, MACRO_EXPANSION,
  disable LaTeX output
- Rewrite mainpage.dox: modern overview with ABM/NRM modes, correct
  callback signatures, UI frames, CRC options, buffer sizing guide,
  and platform list
- Rewrite arduino.dox: add Full-Duplex protocol examples (ABM mode,
  dynamic buffer, connection events), update Light protocol examples
- Add getting_started.dox: step-by-step guide for C API (ABM, NRM
  primary/secondary, UI frames), C++ API (static/dynamic), Python API
- Fix tiny_fd.h: update file brief for ABM+NRM, remove stale NRM
  'in development' warning, add detailed defgroup description with
  usage steps, fix 'ballanced' typo, TINY_NO_ERROR->TINY_SUCCESS
- Fix TinyProtocolFd.h: update file brief, fix 'incapsulates' typo,
  add ABM/NRM mode info to IFd class docs, improve Fd<N>/FdD docs
- Fix TinyProtocolHdlc.h: update file brief, fix misleading
  'confirmation' claim, correct class description
- Fix TinyLightProtocol.h: update file brief, fix class name
  inconsistency in docs
- Fix tiny_types.h: 'address if'->'address of', fix TINY_ERR_FAILED
  comment ('Timeout'->'General failure')
- Fix hdlc.h (low level): fix 'FUNCIONS'->'FUNCTIONS' typos,
  improve defgroup description
- Fix hdlc.h (high level): improve defgroup description
- Fix tiny_light.h: add detailed defgroup description,
  TINY_NO_ERROR->TINY_SUCCESS

Author: lexus2k

doxygen.cfg

@@ -4,9 +4,9 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = "Tiny protocol"
-PROJECT_NUMBER         = 1.1.1
-PROJECT_BRIEF          = "Tiny communication protocol for microcontrollers"
+PROJECT_NAME           = "TinyProto"
+PROJECT_NUMBER         = 1.2.0
+PROJECT_BRIEF          = "Lightweight HDLC-based data link protocol for embedded systems"
 PROJECT_LOGO           =
 OUTPUT_DIRECTORY       = ./docs
 CREATE_SUBDIRS         = NO
@@ -29,7 +29,7 @@ SEPARATE_MEMBER_PAGES  = NO
 TAB_SIZE               = 4
 ALIASES                =
 TCL_SUBST              =
-OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_FOR_C  = YES
 OPTIMIZE_OUTPUT_JAVA   = NO
 OPTIMIZE_FOR_FORTRAN   = NO
 OPTIMIZE_OUTPUT_VHDL   = NO
@@ -104,6 +104,7 @@ INPUT                  = README.md \
                          ./src/proto/ \
                          ./src/mainpage.dox \
                          ./src/arduino.dox \
+                         ./src/getting_started.dox \
 
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.h *.cpp *.inl *.impl *.c *.dox *.md
@@ -120,7 +121,7 @@ INPUT_FILTER           =
 FILTER_PATTERNS        =
 FILTER_SOURCE_FILES    = NO
 FILTER_SOURCE_PATTERNS =
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = README.md
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
 #---------------------------------------------------------------------------
@@ -202,7 +203,7 @@ EXTRA_SEARCH_MAPPINGS  =
 #---------------------------------------------------------------------------
 # Configuration options related to the LaTeX output
 #---------------------------------------------------------------------------
-GENERATE_LATEX         = YES
+GENERATE_LATEX         = NO
 LATEX_OUTPUT           = latex
 LATEX_CMD_NAME         = latex
 MAKEINDEX_CMD_NAME     = makeindex
@@ -264,7 +265,7 @@ PERLMOD_MAKEVAR_PREFIX =
 # Configuration options related to the preprocessor
 #---------------------------------------------------------------------------
 ENABLE_PREPROCESSING   = YES
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 EXPAND_ONLY_PREDEF     = NO
 SEARCH_INCLUDES        = YES
 INCLUDE_PATH           =

src/TinyLightProtocol.h

@@ -27,10 +27,10 @@
 */
 
 /**
- This is Tiny light protocol implementation for microcontrollers
+ This is Tiny Light protocol C++ wrapper implementation.
 
  @file
- @brief Tiny light protocol Arduino API
+ @brief Tiny Light protocol C++ API
 */
 
 #ifndef _TINY_LIGHT_PROTOCOL_H_
@@ -54,9 +54,12 @@ namespace tinyproto
  */
 
 /**
- *  ProtoLight class incapsulates Protocol functionality.
- *  Remember that you may use always C-style API functions
- *  instead C++. Please refer to documentation.
+ *  Light class encapsulates the Light protocol functionality.
+ *  It provides simple SLIP-like framing with optional CRC.
+ *  No acknowledgments or retransmission — use it when simplicity
+ *  and low overhead are more important than guaranteed delivery.
+ *
+ *  You may also use the C-style API functions (tiny_light_*) directly.
  */
 class Light
 {

src/TinyProtocolFd.h

@@ -27,10 +27,10 @@
 */
 
 /**
- This is Tiny protocol implementation for microcontrollers
+ This is Tiny protocol Full-Duplex C++ wrapper implementation.
 
  @file
- @brief Tiny protocol Arduino API
+ @brief Tiny Protocol Full Duplex C++ API
 
 */
 #pragma once
@@ -54,11 +54,15 @@ namespace tinyproto
  */
 
 /**
- *  IFd class incapsulates Full Duplex Protocol functionality.
- *  Full Duplex version of the Protocol allows to send messages with
- *  confirmation.
- *  Remember that you may use always C-style API functions
- *  instead C++. Please refer to documentation.
+ *  IFd class encapsulates Full Duplex Protocol functionality.
+ *  It provides reliable communication with sliding window,
+ *  automatic retransmission, and CRC error detection.
+ *  Supports both ABM (peer-to-peer) and NRM (primary/secondary) modes.
+ *
+ *  Use Fd<N> for static buffer allocation (embedded systems) or
+ *  FdD for dynamic allocation (desktop / powerful MCUs).
+ *
+ *  You may also use the C-style API functions (tiny_fd_*) directly.
  */
 class IFd
 {
@@ -343,7 +347,9 @@ class IFd
 };
 
 /**
- * This is class, which allocates buffers statically. Use it for systems with low resources.
+ * This is class, which allocates buffers statically. Use it for embedded systems with limited resources.
+ * Template parameter S specifies the buffer size in bytes. Use tiny_fd_buffer_size_by_mtu()
+ * to calculate the required size for your MTU and window configuration.
  */
 template <int S> class Fd: public IFd
 {
@@ -358,9 +364,9 @@ template <int S> class Fd: public IFd
 };
 
 /**
- * This is special class for Full duplex protocol, which allocates buffers dynamically.
- * We need to have separate class for this, as on small microcontrollers dynamic allocation
- * in basic class increases flash consumption, even if dynamic memory is not used.
+ * This is special class for Full Duplex protocol, which allocates buffers dynamically.
+ * Use it on desktop systems or powerful microcontrollers where heap allocation is acceptable.
+ * On small microcontrollers, prefer Fd<N> to avoid pulling in dynamic allocation code.
  */
 class FdD: public IFd
 {

src/TinyProtocolHdlc.h

@@ -27,10 +27,10 @@
 */
 
 /**
- This is Tiny protocol implementation for microcontrollers
+ This is Tiny protocol HDLC C++ wrapper implementation.
 
  @file
- @brief Tiny protocol Arduino API
+ @brief Tiny Protocol HDLC C++ API
 
 */
 #pragma once
@@ -53,11 +53,13 @@ namespace tinyproto
  */
 
 /**
- *  Hdlc class incapsulates hdlc Protocol functionality.
- *  hdlc version of the Protocol allows to send messages with
- *  confirmation.
- *  Remember that you may use always C-style API functions
- *  instead C++. Please refer to documentation.
+ *  Hdlc class encapsulates HDLC low-level framing functionality.
+ *  It handles flag bytes (0x7E), byte stuffing, and CRC validation.
+ *  This class provides raw HDLC framing — it does not perform
+ *  acknowledgments or retransmission. For reliable delivery,
+ *  use the Full Duplex protocol (IFd / Fd<N> / FdD).
+ *
+ *  You may also use the C-style API functions (hdlc_*) directly.
  */
 class Hdlc
 {