Added doxygen documentation to GitLab pages as suggested in https://github.com/openjournals/joss-reviews/issues/1592#issuecomment-515643495
This commit is contained in:
parent
852281f347
commit
dcc6090678
4 changed files with 2556 additions and 2 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -24,3 +24,5 @@ status_code_test
|
|||
|
||||
# Visual Studio 2015/2017 cache/options directory
|
||||
.vs
|
||||
|
||||
doxygen/documentation
|
||||
|
|
|
|||
|
|
@ -34,3 +34,16 @@ static-analysis:
|
|||
image: "registry.gitlab.com/eidheim/docker-images:arch"
|
||||
script:
|
||||
- scan-build cmake .. && scan-build --status-bugs make
|
||||
|
||||
pages:
|
||||
image: alpine
|
||||
script:
|
||||
- apk update && apk add doxygen
|
||||
- cd .. && doxygen doxygen/Doxyfile
|
||||
- mv doxygen/documentation/html/ public/
|
||||
artifacts:
|
||||
paths:
|
||||
- public
|
||||
only:
|
||||
- master
|
||||
|
||||
|
|
|
|||
|
|
@ -20,9 +20,11 @@ See https://gitlab.com/eidheim/Simple-WebSocket-Server for an easy way to make W
|
|||
|
||||
### Usage
|
||||
|
||||
See [http_examples.cpp](http_examples.cpp) or [https_examples.cpp](https_examples.cpp) for example usage.
|
||||
See [http_examples.cpp](https://gitlab.com/eidheim/Simple-Web-Server/blob/master/http_examples.cpp) or
|
||||
[https_examples.cpp](https://gitlab.com/eidheim/Simple-Web-Server/blob/master/https_examples.cpp) for example usage.
|
||||
Particularly, the JSON-POST (using Boost.PropertyTree) and the GET /match/[number] examples might be relevant.
|
||||
|
||||
See particularly the JSON-POST (using Boost.PropertyTree) and the GET /match/[number] examples, which are most relevant.
|
||||
[Documentation](https://eidheim.gitlab.io/Simple-Web-Server/annotated.html) is also available, generated from the master branch.
|
||||
|
||||
### Dependencies
|
||||
|
||||
|
|
|
|||
2537
doxygen/Doxyfile
Normal file
2537
doxygen/Doxyfile
Normal file
File diff suppressed because it is too large
Load diff
Loading…
Add table
Add a link
Reference in a new issue