0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

wmlscope: document external docstring directive

Browse source
This commit is contained in:
Elvish_Hunter 2021-07-04 12:09:50 +02:00
parent ddc51d5d46
commit b397ca6262
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
data/tools/wmlscope
View file

@ -53,6 +53,18 @@
# it has seen. This will be useful mainly for symbols that have different
# definitions enabled by an #ifdef.
#
# Due to a preprocessor limitation, inline macros cannot contain a documentation
# string. If you need to document these macros in the HTML macro reference, you
# can use the following directive:
#
# # wmlscope: docstring FOOBAR
#
# The docstring for the FOOBAR macro will be collected until a non-comment line,
# a #define or another # wmlscope: docstring are found. External docstrings
# *must* be defined before the macro they're referring to; defining two or more
# external docstrings keeps only the most recent one, but having both an
# external and an internal docstring is allowed (in this case, the internal one
# will be appended to the external one in the macro reference).
#
# This tool does catch one kind of implicit reference: if an attack name
# is specified but no icon is given, the attack icon will default to