Browse Source

feature: add doxygen configuration

master
Jørgen Lien Sellæg 10 years ago
parent
commit
b450ef281f
  1. 26
      toREST/README.md
  2. 2320
      toREST/docs/Doxyfile.in
  3. 11
      toREST/share/config.json

26
toREST/README.md

@ -0,0 +1,26 @@
toREST
==========
A restful http server for managing torrents.
## About
toREST is written in modern C++14 and can be used with any http client for
managing torrents. A React client called lay is also under development. There
are also plans for a chrome extension in which integrates downloading of
torrents with for instance The Pirate Bay.
## Introduction
See tests for progress.
## Documentation
Using the following syntax with comments to get doxygen comments:
```c++
/*! this will show up when hovering functions etc. */
/*! \brief this will show up when hovering
This will only show up in doxygen
*/
/// this will show up when hovering functions etc.
```

2320
toREST/docs/Doxyfile.in

File diff suppressed because it is too large Load Diff

11
toREST/share/config.json

@ -0,0 +1,11 @@
{
"webserver":{
"port":"8080",
"public_path":"./public",
"threads":"4"
},
"websocket": {
"port":"8080",
"threads":"4"
}
}
Loading…
Cancel
Save