Skip to content

Commit 31024bf

Browse files
committed
added config option excluded_symbols
closes #36
1 parent aec6d30 commit 31024bf

4 files changed

Lines changed: 16 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## v0.18.0 - 2024-08-03
4+
5+
- added config option `excluded_symbols` (a.k.a. Doxygen's `EXCLUDE_SYMBOLS`) (#36) (@Guekka)
6+
37
## v0.17.2 - 2024-06-16
48

59
- fixed qualified return types appearing squashed together without whitespace in some circumstances

src/poxy/project.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1059,6 +1059,7 @@ class Context(object):
10591059
Optional(r'description'): Stripped(str),
10601060
Optional(r'examples'): FilteredInputs.schema,
10611061
Optional(r'extra_files'): ValueOrArray(str, name=r'extra_files'),
1062+
Optional(r'excluded_symbols'): ValueOrArray(str, name=r'excluded_symbols'),
10621063
Optional(r'favicon'): Stripped(str),
10631064
Optional(r'generate_tagfile'): bool,
10641065
Optional(r'github'): Stripped(str),
@@ -1781,6 +1782,13 @@ def add_internal_asset(p) -> str:
17811782
self.inline_namespaces.add(namespace)
17821783
self.verbose_value(r'Context.inline_namespaces', self.inline_namespaces)
17831784

1785+
self.excluded_symbols = set()
1786+
if 'excluded_symbols' in config:
1787+
for symbol in coerce_collection(config['excluded_symbols']):
1788+
symbol = symbol.strip()
1789+
if symbol:
1790+
self.excluded_symbols.add(symbol)
1791+
17841792
# implementation headers
17851793
self.implementation_headers = []
17861794
if 'implementation_headers' in config:

src/poxy/run.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,9 @@ def preprocess_doxyfile(context: Context):
197197

198198
df.set_value(r'USE_MDFILE_AS_MAINPAGE', context.main_page)
199199

200+
if context.excluded_symbols:
201+
df.set_value(r'EXCLUDE_SYMBOLS', context.excluded_symbols)
202+
200203
df.append()
201204
df.append(r'# context.warnings', end='\n\n') # ---------------------------------------------------
202205

src/poxy/version.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.17.2
1+
0.18.0

0 commit comments

Comments
 (0)