Skip to content

Commit e8cb7b8

Browse files
committed
docs updated
1 parent 8bdf697 commit e8cb7b8

File tree

1 file changed

+36
-4
lines changed

1 file changed

+36
-4
lines changed

docs/doxygen.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,15 @@ The most important sections are:
88

99
**PROJECT_NAME**
1010

11-
```PROJECT_NAME= "Simple Example"
11+
```
12+
PROJECT_NAME= "Simple Example"
1213
```
1314

1415

1516
**INPUT**
1617
path to your source code:
1718
```
18-
INPUT=./source
19+
INPUT=/cpp_tutorials/src
1920
```
2021

2122
**DOT_PATH**
@@ -33,8 +34,7 @@ DOT_PATH =/usr/bin/dot
3334
**OUTPUT**
3435

3536
```
36-
HTML_OUTPUT = doc/html
37-
OUTPUT_DIRECTORY = .
37+
HTML_OUTPUT = /cpp_tutorials/html
3838
```
3939

4040
or you can run
@@ -55,6 +55,38 @@ and see your modified values in red:
5555
<img src="images/doxygen5.png" width="80%" height="80%"/>
5656

5757

58+
59+
60+
61+
62+
5863
## Doxygen UML Diagram and Graph Legend
5964

6065
[Doxygen uml diagram and graph legend](https://www.doxygen.nl/manual/examples/diagrams/html/graph_legend.html)
66+
67+
68+
## Update Dockerfile
69+
70+
```
71+
RUN apt-get update && apt-get install -y \
72+
git \
73+
cmake \
74+
ninja-build \
75+
doxygen \
76+
build-essential \
77+
graphviz \
78+
&& rm -rf /var/lib/apt/lists/*
79+
```
80+
[Full example](../Dockerfile)
81+
82+
## Update GitHub Action
83+
84+
```
85+
- name: Generate Doxygen documentation
86+
run: docker run --rm -v ${{ github.workspace }}:/cpp_tutorials mycpp_image:latest doxygen /cpp_tutorials/Doxyfile
87+
88+
- name: List generated documentation files
89+
run: docker run --rm -v ${{ github.workspace }}:/cpp_tutorials mycpp_image:latest ls -la /cpp_tutorials/docs
90+
```
91+
92+
[Full example](../.github/workflows/docker-build.yml)

0 commit comments

Comments
 (0)