[Doc] Doc formating using pre-commit

Author: Grom-

.github/ISSUE_TEMPLATE.md

@@ -23,7 +23,7 @@ A clear and concise description of what the bug is.
 **How to reproduce the bug (skip if none)**
 
 1. Indicate the global behavior of your application project
-2. List the SW modules that you suspect to be the cause of the problem 
+2. List the SW modules that you suspect to be the cause of the problem
 3. Describe the use case that generates the problem
 4. How we can reproduce the problem
 

.github/workflows/doxygen-gh-pages.yml

@@ -15,4 +15,4 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: gh-pages
           folder: doc
-          config_file: doc/STSELib.doxyfile
+          config_file: doc/STSELib.doxyfile

LICENSE.txt

@@ -24,4 +24,4 @@ ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -2,9 +2,9 @@
 
 ![STSELib](doc/resources/Pictures/STSELib.png)
 
-The STSELib middleware provides a complete set of high-level Application Programming Interface functions to the embedded system developer. This Middleware abstract the build and the sequencing of the commands required to ensure device , accessories and consumable brand protection using STMicroelectronics STSAFE-A secure element family. 
+The STSELib middleware provides a complete set of high-level Application Programming Interface functions to the embedded system developer. This Middleware abstract the build and the sequencing of the commands required to ensure device , accessories and consumable brand protection using STMicroelectronics STSAFE-A secure element family.
 
-This middleware allows a seamless integration of one or multiple STSAFE-A in various host MCU/MPU ecosystem.				
+This middleware allows a seamless integration of one or multiple STSAFE-A in various host MCU/MPU ecosystem.
 
 The STSELib middleware is composed of three software modules as illustrated in the figure below. Each layer provides a different level of system abstraction to the embedded system developer.
 
@@ -14,7 +14,7 @@ The STSELib middleware is composed of three software modules as illustrated in t
 This software layer is the entry point for the system application. It provides a set of high level functions allowing interaction with STMicroelectronics Secure Elements.
 
 <b>- Service layer</b>
-Provides a set of product services that format all commands supported by the targeted secure element and reports response to higher layers API/Application . This layer can be used directly from Application (for advanced user). 
+Provides a set of product services that format all commands supported by the targeted secure element and reports response to higher layers API/Application . This layer can be used directly from Application (for advanced user).
 
 <b>- Core layer</b>
 Contains generic definition for ST Secure Element and functions for communicating with target secure element.
@@ -41,7 +41,7 @@ Two headers files are mantatories, [`stse_conf.h`](doc/resources/Markdown/03_LIB
 ### 3. Optional files
 
 For platform-specific integrations and STSafe use-cases, you may implement additional headers. Detailed specifications are available in the HTML documentation included in the release ZIP.
-Reference implementation for most common STSE applicative use case can be found in section "Reference applicative examples" of this ReadMe file 
+Reference implementation for most common STSE applicative use case can be found in section "Reference applicative examples" of this ReadMe file
 
 ## Reference applicative examples
 

doc/documentation.html

@@ -1 +1 @@
-<meta http-equiv="refresh" content="0; url=file:.\resources\__html\index.html" />
+<meta http-equiv="refresh" content="0; url=file:.\resources\__html\index.html" />

doc/resources/Markdown/00_introduction.md

@@ -12,13 +12,13 @@ Thanks to its modular architecture, this middleware enables seamless integration
 
 Each layer provides a distinct level of system abstraction for the embedded system developer:
 
-- **Application Programming Interface (API) Layer**: 
+- **Application Programming Interface (API) Layer**:
   This software layer serves as the entry point for the system application. It offers a set of high-level functions that facilitate interaction with STMicroelectronics Secure Elements.
 
-- **Service Layer**: 
+- **Service Layer**:
   This layer provides a set of product services that format all commands supported by the targeted secure element and report responses to the higher layers (API/Application). Advanced users can directly utilize this layer from the application.
 
-- **Core Layer**: 
+- **Core Layer**:
   This layer contains generic definitions for ST Secure Elements and functions for communicating with the target secure element.
 
 For more details on each layer, please refer to the "Modules Documentation" section of the documentation.
@@ -31,8 +31,3 @@ For more details on each layer, please refer to the "Modules Documentation" sect
 \subpage stse_services
 
 \subpage stse_core
-
-
-
-
-

doc/resources/Markdown/01_SOFTWARE LICENSE/01_SOFTWARE LICENSE.md

@@ -26,4 +26,4 @@ ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

doc/resources/Markdown/02_RELEASE_NOTE/release_note.md

@@ -1,7 +1,7 @@
 # Release Note
 
 ## v1.1.0 (Latest)
-- [all] Library performance and footprint optimization based on stse_conf.h  
+- [all] Library performance and footprint optimization based on stse_conf.h
 - [certificate parser] Add ED25519 support
 - [api] Add STSAFEL support to STSE ECC APIs
 - [api] Add STSAFEL support to STSE Data storage APIs
@@ -19,7 +19,7 @@
 
 ## v1.0.3
 - [core] Fix frame debug log usage
-- [services] Fix echo usage into host session 
+- [services] Fix echo usage into host session
 - [services & api] Add host key establishment v2
 - [api] Fix hash computation
 
@@ -29,7 +29,7 @@
 - [api] Add symmetric key slot provisioning api
 - [stsafea] Add AES-GCM & AES-CCM* by chunck
 - [stsafea] Add public key slot management
-- [stsafea] Add entity authentication  
+- [stsafea] Add entity authentication
 - [stsafea] Update A120 timings
 - [core] Simplify I2C platform
 - [core] Add SE return status when debug log activated
@@ -45,4 +45,4 @@
 - [stsafea] add clear session
 - [stsafea] Fix query generic public key slot info
 - [stsafea] Fix some issues with CMAC authenticated commands
-- [core] Change STSE handler initialization
+- [core] Change STSE handler initialization

doc/resources/Markdown/03_LIBRARY_CONFIGURATION/03_LIBRARY_CONFIGURATION.md

@@ -1,11 +1,11 @@
-# Library configuration 
+# Library configuration
 
-To operate , the STSELib relies on specific configuration parametters to be defined in each applicative projects embedding the library . 
-A template of the  STSELib_config.h file to be added to each project is available in the template directory of the library. 
-It is recommended to included the file in each projects along with a path to this file in compiler pre-processor include path. 
+To operate , the STSELib relies on specific configuration parametters to be defined in each applicative projects embedding the library .
+A template of the  STSELib_config.h file to be added to each project is available in the template directory of the library.
+It is recommended to included the file in each projects along with a path to this file in compiler pre-processor include path.
 
 This configuration file allows the adjustment of API/Services/Core performance , platform call-back adaptation and size optimization of the library .
-It is recommended to adjust each application configuration file according to end-application requirements and ST SecureElement type and perso profile. Please also note that the configuration of these parametters allows to simplify the STSELib porting requirement as it helps identifying the low-level callbacks to be implemented at application level to integrate the library on a specific host MCU/MPU host platform   . 
+It is recommended to adjust each application configuration file according to end-application requirements and ST SecureElement type and perso profile. Please also note that the configuration of these parametters allows to simplify the STSELib porting requirement as it helps identifying the low-level callbacks to be implemented at application level to integrate the library on a specific host MCU/MPU host platform   .
 
 Here is a typical STSELib_config.h definition, followed by an explanation of each parameter:
 
@@ -126,30 +126,30 @@ extern "C" {
 ```
 
 
-The following table lits all parametters 
+The following table lits all parametters
 
 
-| <b>Definition</b> | <b>Description</b> | <b>Associated STSE Product Family</b> 
+| <b>Definition</b> | <b>Description</b> | <b>Associated STSE Product Family</b>
 | :----    |    :----   | :---- |
 | STSE_CONF_STSAFE_A_SUPPORT | Enable STSAFE-A APIs/services support | STSAFE-A
 | STSE_CONF_STSAFE_L_SUPPORT | Enable STSAFE-L APIs/services support | STSAFE-L
 | STSE_CONF_ECC_NIST_P_256 | Enable ECC NIST-P256 support in API/services/platform | STSAFE-A / STSAFE-L
-| STSE_CONF_ECC_NIST_P_384 | Enable ECC NIST-P384 support in API/services/platform | STSAFE-A 
-| STSE_CONF_ECC_NIST_P_521 | Enable ECC NIST-P521 support in API/services/platform | STSAFE-A 
-| STSE_CONF_ECC_BRAINPOOL_P_256 | Enable ECC NIST-P256 support in API/services/platform | STSAFE-A 
-| STSE_CONF_ECC_BRAINPOOL_P_384 | Enable ECC NIST-P384 support in API/services/platform | STSAFE-A 
-| STSE_CONF_ECC_BRAINPOOL_P_512 | Enable ECC NIST-P512 support in API/services/platform | STSAFE-A 
+| STSE_CONF_ECC_NIST_P_384 | Enable ECC NIST-P384 support in API/services/platform | STSAFE-A
+| STSE_CONF_ECC_NIST_P_521 | Enable ECC NIST-P521 support in API/services/platform | STSAFE-A
+| STSE_CONF_ECC_BRAINPOOL_P_256 | Enable ECC NIST-P256 support in API/services/platform | STSAFE-A
+| STSE_CONF_ECC_BRAINPOOL_P_384 | Enable ECC NIST-P384 support in API/services/platform | STSAFE-A
+| STSE_CONF_ECC_BRAINPOOL_P_512 | Enable ECC NIST-P512 support in API/services/platform | STSAFE-A
 | STSE_CONF_ECC_CURVE_25519 | Enable CURVE25519 support in API/services/platform | STSAFE-A / STSAFE-L
 | STSE_CONF_ECC_EDWARD_25519 | Enable ED25519 support in API/services/platform | STSAFE-A / STSAFE-L
-| STSE_CONF_HASH_SHA_1 | Enable SHA-1 support in API/services/platform | STSAFE-A 
-| STSE_CONF_HASH_SHA_224 | Enable SHA224 support in API/services/platform | STSAFE-A 
-| STSE_CONF_HASH_SHA_256 | Enable SHA256 support in API/services/platform | STSAFE-A 
-| STSE_CONF_HASH_SHA_384 | Enable SHA384 support in API/services/platform | STSAFE-A 
-| STSE_CONF_HASH_SHA_512 | Enable SHA512 support in API/services/platform | STSAFE-A 
-| STSE_CONF_HASH_SHA_3_256 | Enable SHA3-256 support in API/services/platform | STSAFE-A 
-| STSE_CONF_HASH_SHA_3_384 | Enable SHA3-384 support in API/services/platform | STSAFE-A 
-| STSE_CONF_HASH_SHA_3_512 | Enable SHA3-512 support in API/services/platform | STSAFE-A 
-| STSE_CONF_USE_HOST_SESSION | Enable Host session support in services/platform | STSAFE-A 
+| STSE_CONF_HASH_SHA_1 | Enable SHA-1 support in API/services/platform | STSAFE-A
+| STSE_CONF_HASH_SHA_224 | Enable SHA224 support in API/services/platform | STSAFE-A
+| STSE_CONF_HASH_SHA_256 | Enable SHA256 support in API/services/platform | STSAFE-A
+| STSE_CONF_HASH_SHA_384 | Enable SHA384 support in API/services/platform | STSAFE-A
+| STSE_CONF_HASH_SHA_512 | Enable SHA512 support in API/services/platform | STSAFE-A
+| STSE_CONF_HASH_SHA_3_256 | Enable SHA3-256 support in API/services/platform | STSAFE-A
+| STSE_CONF_HASH_SHA_3_384 | Enable SHA3-384 support in API/services/platform | STSAFE-A
+| STSE_CONF_HASH_SHA_3_512 | Enable SHA3-512 support in API/services/platform | STSAFE-A
+| STSE_CONF_USE_HOST_SESSION | Enable Host session support in services/platform | STSAFE-A
 | STSE_CONF_USE_HOST_KEY_ESTABLISHMENT | Enable Host key establishment support via ECDH and key derivation | STSAFE-A
 | STSE_CONF_USE_HOST_KEY_PROVISIONING_WRAPPED | Enable Host key secure provisioning using KEK wrapped exchange | STSAFE-A
 | STSE_CONF_USE_HOST_KEY_PROVISIONING_WRAPPED_AUTHENTICATED  | Enable Host key secure provisioning using KEK wrapped exchange and authentication | STSAFE-A
@@ -163,5 +163,3 @@ The following table lits all parametters
 | STSE_FIRST_POLLING_INTERVAL | First polling delay definition in ms (see section below) | STSAFE-A / STSAFE-L
 | STSE_POLLING_RETRY_INTERVAL | Polling retry interval definition in ms (see section below) | STSAFE-A / STSAFE-L
 | STSE_FRAME_DEBUG_LOG | Enable HOST<->STSE communication logs | STSAFE-A / STSAFE-L
-
- 

doc/resources/Markdown/04_PORTING_GUIDE/03_PORTINNG_GUIDE.md

@@ -16,7 +16,7 @@ This Platform Abstraction Layer decouples the STSELibrary Middleware from the un
 
 ![PAL_integration](../Pictures/PAL_integration.png)
 
-# Identifying the platform abstraction functions to be implemented 
+# Identifying the platform abstraction functions to be implemented
 
 To assist developers in identifying the callback functions to be developed and simplify the porting process of the library, it is recommended to use an stse_config.h file that activates only the configuration parameters required by the end application (see Library Configuration documentation section). By doing this, advanced IDEs such as STM32Cube IDE will highlight which platform functions need to be ported. Below is an extract of the platform configuration:
 
@@ -41,4 +41,3 @@ Following platform files architecture are recommended to simplify the porting of
 - @subpage stse_platform_power
 - @subpage stse_platform_i2c
 - @subpage stse_platform_st1wire
-