File tree Expand file tree Collapse file tree 1 file changed +36
-4
lines changed Expand file tree Collapse file tree 1 file changed +36
-4
lines changed Original file line number Diff line number Diff line change @@ -8,14 +8,15 @@ The most important sections are:
8
8
9
9
** PROJECT_NAME**
10
10
11
- ``` PROJECT_NAME= "Simple Example"
11
+ ```
12
+ PROJECT_NAME= "Simple Example"
12
13
```
13
14
14
15
15
16
** INPUT**
16
17
path to your source code:
17
18
```
18
- INPUT=./source
19
+ INPUT=/cpp_tutorials/src
19
20
```
20
21
21
22
** DOT_PATH**
@@ -33,8 +34,7 @@ DOT_PATH =/usr/bin/dot
33
34
** OUTPUT**
34
35
35
36
```
36
- HTML_OUTPUT = doc/html
37
- OUTPUT_DIRECTORY = .
37
+ HTML_OUTPUT = /cpp_tutorials/html
38
38
```
39
39
40
40
or you can run
@@ -55,6 +55,38 @@ and see your modified values in red:
55
55
<img src =" images/doxygen5.png " width =" 80% " height =" 80% " />
56
56
57
57
58
+
59
+
60
+
61
+
62
+
58
63
## Doxygen UML Diagram and Graph Legend
59
64
60
65
[ 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 )
You can’t perform that action at this time.
0 commit comments