summaryrefslogtreecommitdiff
path: root/scripts/cpp_examples_for_doxygen.py
diff options
context:
space:
mode:
authorVincent Rouvreau <10407034+VincentRouvreau@users.noreply.github.com>2021-09-07 17:51:27 +0200
committerGitHub <noreply@github.com>2021-09-07 17:51:27 +0200
commit8adb46d8a54f1a0dd71ea686473cc4ca9f5d2f67 (patch)
tree591dda6036f78a8812352b2ffe1694827da9ee92 /scripts/cpp_examples_for_doxygen.py
parent90beaa73a3f34b0c4b97f0be76ee30328dba7d54 (diff)
parent4db14bad8006638fc8249cb867a1720f581e044d (diff)
Merge pull request #527 from VincentRouvreau/fix_documentation_broken_links
Fix broken links. Add a tool to generate cpp example page
Diffstat (limited to 'scripts/cpp_examples_for_doxygen.py')
-rw-r--r--scripts/cpp_examples_for_doxygen.py16
1 files changed, 16 insertions, 0 deletions
diff --git a/scripts/cpp_examples_for_doxygen.py b/scripts/cpp_examples_for_doxygen.py
new file mode 100644
index 00000000..5c091c4f
--- /dev/null
+++ b/scripts/cpp_examples_for_doxygen.py
@@ -0,0 +1,16 @@
+import os
+import glob
+
+for gd_mod in glob.glob("src/*/"):
+ mod_files = []
+ for paths in [gd_mod + 'utilities', gd_mod + 'example']:
+ if os.path.isdir(paths):
+ for root, dirs, files in os.walk(paths):
+ for file in files:
+ if file.endswith(".cpp"):
+ mod_files.append(str(os.path.join(root, file)).split(paths)[1][1:])
+ if len(mod_files) > 0:
+ mod = str(gd_mod).split('/')[1]
+ print(' * \section ' + mod + '_example_section ' + mod)
+ for file in mod_files:
+ print(' * @example ' + file)