Working cpp documentation breathe + exhale
This commit is contained in:
parent
8dfcbf83f5
commit
70e39d375e
6 changed files with 31 additions and 21 deletions
20
cpp-example/include/Driver.h
Normal file
20
cpp-example/include/Driver.h
Normal 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;
|
||||
};
|
|
@ -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);
|
|
@ -7,11 +7,11 @@
|
|||
## :wrench: Dependencies installation
|
||||
|
||||
```sh
|
||||
pip3 install sphinx breathe
|
||||
pip3 install sphinx breathe exhale
|
||||
sudo apt-get install doxygen
|
||||
```
|
||||
|
||||
## :rocket: Compile documentation
|
||||
## :rocket: Générer la documentation
|
||||
|
||||
```sh
|
||||
cd docs
|
||||
|
|
8
cpp-example/src/Driver.cpp
Normal file
8
cpp-example/src/Driver.cpp
Normal file
|
@ -0,0 +1,8 @@
|
|||
#include "Driver.h"
|
||||
|
||||
|
||||
int Driver::write(unsigned char *buffer)
|
||||
{
|
||||
// Do something
|
||||
return 0;
|
||||
}
|
|
@ -1,6 +0,0 @@
|
|||
#include "driver.h"
|
||||
|
||||
int add(int x, int y)
|
||||
{
|
||||
return x + y;
|
||||
}
|
|
@ -1,6 +1,6 @@
|
|||
#include <iostream>
|
||||
|
||||
#include "driver.h"
|
||||
#include "Driver.h"
|
||||
|
||||
int main(int argc, char* argv[])
|
||||
{
|
||||
|
|
Loading…
Reference in a new issue