Skip to content

Commit e50219d

Browse files
committed
[UPDATE] the doxyfile to hopefully include the code files as reference when generating the documentation
1 parent c7ad1d7 commit e50219d

File tree

3 files changed

+27
-6
lines changed

3 files changed

+27
-6
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ Although tailored for Asperguide, it is available on the VS Code Marketplace for
99

1010
---
1111

12+
## Developper documentation
13+
14+
You can find the developper documentation [here (generated by doxygen)](https://asperguide.github.io/asper-header/): [https://asperguide.github.io/asper-header/](https://asperguide.github.io/asper-header/)
15+
16+
---
17+
1218
## Features
1319

1420
- Insert structured headers into your source files with a single command.
@@ -36,7 +42,7 @@ Although tailored for Asperguide, it is available on the VS Code Marketplace for
3642

3743
### Demo
3844

39-
Bellow is a video demoing the different features of the extension:
45+
Bellow is a video demoing the different features of the extension: (sorry for the low quality, github filesize restrictions oblige)
4046

4147
If animation fails to load, [click here (gif)](https://github.com/Asperguide/asper-header/blob/main/images/demo/asper_header_timeline.gif) or [here (mp4)](https://github.com/Asperguide/asper-header/blob/main/images/demo/asper_header_timeline.mp4)
4248
![Extension demo](./images/demo/asper_header_timeline.gif)

doxygen_generation/Doxyfile

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -649,7 +649,7 @@ HIDE_SCOPE_NAMES = NO
649649
# YES the compound reference will be hidden.
650650
# The default value is: NO.
651651

652-
HIDE_COMPOUND_REFERENCE= NO
652+
HIDE_COMPOUND_REFERENCE = NO
653653

654654
# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class
655655
# will show which file needs to be included to use the class.
@@ -759,7 +759,7 @@ GENERATE_BUGLIST = YES
759759
# the documentation.
760760
# The default value is: YES.
761761

762-
GENERATE_DEPRECATEDLIST= YES
762+
GENERATE_DEPRECATEDLIST = YES
763763

764764
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
765765
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
@@ -1007,8 +1007,10 @@ FILE_PATTERNS = *.c \
10071007
*.h++ \
10081008
*.py \
10091009
*.pyw \
1010-
*.js \
10111010
*.ts \
1011+
*.tsx \
1012+
*.js \
1013+
*.jsx \
10121014
Makefile
10131015

10141016
# The RECURSIVE tag can be used to specify whether or not subdirectories should
@@ -2402,7 +2404,14 @@ INCLUDE_PATH =
24022404

24032405
INCLUDE_FILE_PATTERNS = *.h \
24042406
*.hpp \
2405-
*.h++
2407+
*.h++ \
2408+
*.py \
2409+
*.pyw \
2410+
*.ts \
2411+
*.tsx \
2412+
*.js \
2413+
*.jsx \
2414+
Makefile
24062415

24072416
# The PREDEFINED tag can be used to specify one or more macro names that are
24082417
# defined before the preprocessor is started (similar to the -D option of e.g.

vscode/asperheader/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ Although tailored for Asperguide, it is available on the VS Code Marketplace for
99

1010
---
1111

12+
## Developper documentation
13+
14+
You can find the developper documentation [here (generated by doxygen)](https://asperguide.github.io/asper-header/): [https://asperguide.github.io/asper-header/](https://asperguide.github.io/asper-header/)
15+
16+
---
17+
1218
## Features
1319

1420
- Insert structured headers into your source files with a single command.
@@ -36,7 +42,7 @@ Although tailored for Asperguide, it is available on the VS Code Marketplace for
3642

3743
### Demo
3844

39-
Bellow is a video demoing the different features of the extension:
45+
Bellow is a video demoing the different features of the extension: (sorry for the low quality, github filesize restrictions oblige)
4046

4147
If animation fails to load, [click here (gif)](https://github.com/Asperguide/asper-header/blob/main/images/demo/asper_header_timeline.gif) or [here (mp4)](https://github.com/Asperguide/asper-header/blob/main/images/demo/asper_header_timeline.mp4)
4248
![Extension demo](./images/demo/asper_header_timeline.gif)

0 commit comments

Comments
 (0)