Working cpp documentation breathe + exhale

This commit is contained in:
Alexandre Foucher 2024-01-23 17:43:24 +01:00
parent 8dfcbf83f5
commit 70e39d375e
6 changed files with 31 additions and 21 deletions

View file

@ -0,0 +1,20 @@
/** @file */
/**
* @class Driver
* @brief Driver example
*/
class Driver
{
public:
/**
* @brief Write byte to a sensor
*
* @param[in] buffer description of parameter1
* @return status return the termination status
*/
int write(unsigned char *buffer);
private:
bool mIsActive;
};

View file

@ -1,12 +0,0 @@
/**
* @file driver.h
*/
/** @brief function short description
*
* function longer description if need
* @param[in] x description of parameter1
* @param[in] y description of parameter2
* @return return_name return description
*/
int add(int x, int y);

View file

@ -7,11 +7,11 @@
## :wrench: Dependencies installation ## :wrench: Dependencies installation
```sh ```sh
pip3 install sphinx breathe pip3 install sphinx breathe exhale
sudo apt-get install doxygen sudo apt-get install doxygen
``` ```
## :rocket: Compile documentation ## :rocket: Générer la documentation
```sh ```sh
cd docs cd docs

View file

@ -0,0 +1,8 @@
#include "Driver.h"
int Driver::write(unsigned char *buffer)
{
// Do something
return 0;
}

View file

@ -1,6 +0,0 @@
#include "driver.h"
int add(int x, int y)
{
return x + y;
}

View file

@ -1,6 +1,6 @@
#include <iostream> #include <iostream>
#include "driver.h" #include "Driver.h"
int main(int argc, char* argv[]) int main(int argc, char* argv[])
{ {