Skip to content

Commit 5e63ed8

Browse files
authored
Merge pull request #7 from francesco086/doxygen
Doxygen
2 parents cb5f60f + 408964f commit 5e63ed8

File tree

5 files changed

+2513
-0
lines changed

5 files changed

+2513
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,5 @@ doc/*.fls
8686
doc/*.ilg
8787
doc/*.ind
8888
doc/auto
89+
90+
doc/doxygen/*/*

doc/doxygen/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Doxygen
2+
3+
Doxygen is documentation generator and is able to generate visualization of the code structure.
4+
5+
## Usage
6+
7+
First you need to install doxygen and the dot tool (graphviz), then invoke the following on the command prompt (inside doxygen folder):
8+
9+
```bash
10+
doxygen doxygen.conf
11+
```
12+
13+
Now you may view the created webpage by opening the doxygen.html symlink with a webbrowser of your choice, e.g.:
14+
15+
```bash
16+
firefox doxygen.html
17+
```

0 commit comments

Comments
 (0)