diff options
Diffstat (limited to 'doc/doxyfile.in')
| -rw-r--r-- | doc/doxyfile.in | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/doc/doxyfile.in b/doc/doxyfile.in index 47622e6..9a44a6a 100644 --- a/doc/doxyfile.in +++ b/doc/doxyfile.in @@ -301,7 +301,7 @@ EXTENSION_MAPPING = # case of backward compatibilities issues. # The default value is: YES. -MARKDOWN_SUPPORT = NO +MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can @@ -2000,7 +2000,9 @@ PREDEFINED = SFML_SYSTEM_API \ SFML_NETWORK_API \ SFML_WINDOW_API \ SFML_AUDIO_API \ - SFML_GRAPHICS_API + SFML_GRAPHICS_API \ + SFML_DEPRECATED \ + SFML_DOXYGEN # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The @@ -2375,3 +2377,21 @@ GENERATE_LEGEND = YES # This tag requires that the tag HAVE_DOT is set to YES. DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# SFML specific aliases +#--------------------------------------------------------------------------- + +# sfplatform{platform(s)} +# sfplatform{platform(s), header} +# +# Warns the user that some specific class or function is only available on +# specific platforms. +# +# This shouldn't be used for incomplete implementations. It's meant for things +# that will never appear on another platform, e.g. Android's native activity. +# +# If a header is given, the user is informed, that this header must be included +# for the mentioned element to be defined. +ALIASES += sfplatform{1}="<dl class=\"attention\"><dt>Platform Limitation</dt><dd><b>This is only available on \1.</b></dd></dl>" +ALIASES += sfplatform{2}="<dl class=\"attention\"><dt>Platform Limitation</dt><dd><b>This is only available on \1</b> and to use it, you'll have to specifically include \2 in your code.</dd></dl>" |