Skip to content

Commit

Permalink
Added doxygen documentation to GitLab pages as suggested in openjourn…
Browse files Browse the repository at this point in the history
  • Loading branch information
eidheim committed Jul 28, 2019
1 parent 852281f commit dcc6090
Show file tree
Hide file tree
Showing 4 changed files with 2,556 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,5 @@ status_code_test

# Visual Studio 2015/2017 cache/options directory
.vs

doxygen/documentation
13 changes: 13 additions & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading

0 comments on commit dcc6090

Please sign in to comment.