From ff835be2ac8547b402cf66fafbe206c1f7e87196 Mon Sep 17 00:00:00 2001 From: Tom Poole Date: Mon, 17 Jul 2023 17:46:45 +0100 Subject: [PATCH] Doxygen: Fix some Doxygen issues --- docs/doxygen/Doxyfile | 154 ++++++++++++------ .../mpe/juce_MPEZoneLayout.h | 2 + .../audio_io/juce_AudioIODevice.h | 6 +- .../midi_io/juce_MidiDevices.h | 2 + .../format_types/juce_ARAHosting.h | 6 + .../format_types/juce_LV2SupportLibs.cpp | 3 + .../utilities/juce_AudioParameterBool.h | 2 + .../utilities/juce_AudioParameterChoice.h | 2 + .../utilities/juce_AudioParameterFloat.h | 2 + .../utilities/juce_AudioParameterInt.h | 2 + .../juce_AudioProcessorParameterWithID.h | 4 + .../juce_AudioProcessorValueTreeState.h | 2 + .../juce_NativeScaleFactorNotifier.h | 2 + .../utilities/juce_RangedAudioParameter.h | 2 + modules/juce_core/containers/juce_Optional.h | 5 +- modules/juce_core/containers/juce_Span.h | 2 + .../juce_core/files/juce_common_MimeTypes.h | 9 +- modules/juce_core/memory/juce_Reservoir.h | 2 + modules/juce_core/misc/juce_Functional.h | 2 + .../juce_graphics/images/juce_ScaledImage.h | 2 + .../juce_AccessibilityTableInterface.h | 1 + .../windows/juce_ScopedMessageBox.h | 2 + .../windows/juce_VBlankAttachement.h | 5 +- .../windows/juce_WindowUtils.h | 5 + .../misc/juce_WebBrowserComponent.h | 3 + 25 files changed, 170 insertions(+), 59 deletions(-) diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index 9ce59be69d..13de46435d 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.9.6 +# Doxyfile 1.9.8 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -374,6 +374,17 @@ MARKDOWN_SUPPORT = YES TOC_INCLUDE_HEADINGS = 0 +# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to +# generate identifiers for the Markdown headings. Note: Every identifier is +# unique. +# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a +# sequence number starting at 0 and GITHUB use the lower case version of title +# with any whitespace replaced by '-' and punctuation characters removed. +# The default value is: DOXYGEN. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +MARKDOWN_ID_STYLE = DOXYGEN + # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or @@ -498,6 +509,14 @@ LOOKUP_CACHE_SIZE = 0 NUM_PROC_THREADS = 1 +# If the TIMESTAMP tag is set different from NO then each generated page will +# contain the date or date and time when the page was generated. Setting this to +# NO can help when comparing the output of multiple runs. +# Possible values are: YES, NO, DATETIME and DATE. +# The default value is: NO. + +TIMESTAMP = NO + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- @@ -604,7 +623,7 @@ HIDE_IN_BODY_DOCS = YES # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. -INTERNAL_DOCS = YES +INTERNAL_DOCS = NO # With the correct setting of option CASE_SENSE_NAMES doxygen will better be # able to match the capabilities of the underlying filesystem. In case the @@ -883,7 +902,14 @@ WARN_IF_UNDOC_ENUM_VAL = NO # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS # then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but # at the end of the doxygen process doxygen will return with a non-zero status. -# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves +# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not +# write the warning messages in between other messages but write them at the end +# of a run, in case a WARN_LOGFILE is defined the warning messages will be +# besides being in the defined file also be shown at the end of a run, unless +# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case +# the behavior will remain as with the setting FAIL_ON_WARNINGS. +# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT. # The default value is: NO. WARN_AS_ERROR = NO @@ -1026,11 +1052,8 @@ EXCLUDE_PATTERNS = juce_GIFLoader* \ # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # ANamespace::AClass, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = detail # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include @@ -1371,15 +1394,6 @@ HTML_COLORSTYLE_SAT = 100 HTML_COLORSTYLE_GAMMA = 80 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = YES - # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML # documentation will contain a main index with vertical navigation menus that # are dynamically created via JavaScript. If disabled, the navigation index will @@ -1399,6 +1413,14 @@ HTML_DYNAMIC_MENUS = NO HTML_DYNAMIC_SECTIONS = NO +# If the HTML_CODE_FOLDING and SOURCE_BROWSER tags are set to YES then classes +# and functions can be dynamically folded and expanded in the generated HTML +# source code. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_CODE_FOLDING = YES + # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to @@ -1529,6 +1551,16 @@ BINARY_TOC = NO TOC_EXPAND = NO +# The SITEMAP_URL tag is used to specify the full URL of the place where the +# generated documentation will be placed on the server by the user during the +# deployment of the documentation. The generated sitemap is called sitemap.xml +# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL +# is specified no sitemap is generated. For information about the sitemap +# protocol see https://www.sitemaps.org +# This tag requires that the tag GENERATE_HTML is set to YES. + +SITEMAP_URL = + # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help @@ -2017,9 +2049,16 @@ PDF_HYPERLINKS = NO USE_PDFLATEX = NO -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode -# command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. +# The LATEX_BATCHMODE tag ignals the behavior of LaTeX in case of an error. +# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch +# mode nothing is printed on the terminal, errors are scrolled as if is +# hit at every error; missing files that TeX tries to input or request from +# keyboard input (\read on a not open input stream) cause the job to abort, +# NON_STOP In nonstop mode the diagnostic message will appear on the terminal, +# but there is no possibility of user interaction just like in batch mode, +# SCROLL In scroll mode, TeX will stop only for missing files to input or if +# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at +# each error, asking for user intervention. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -2040,14 +2079,6 @@ LATEX_HIDE_INDICES = NO LATEX_BIB_STYLE = plain -# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated -# page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_TIMESTAMP = NO - # The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) # path from which the emoji images will be read. If a relative path is entered, # it will be relative to the LATEX_OUTPUT directory. If left blank the @@ -2213,7 +2244,7 @@ DOCBOOK_OUTPUT = docbook #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an -# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures # the structure of the code including all documentation. Note that this feature # is still experimental and incomplete at the moment. # The default value is: NO. @@ -2275,7 +2306,7 @@ ENABLE_PREPROCESSING = YES # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -MACRO_EXPANSION = NO +MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then # the macro expansion is limited to the macros specified with the PREDEFINED and @@ -2330,7 +2361,16 @@ PREDEFINED = WIN32=1 \ JUCE_COMPILER_SUPPORTS_VARIADIC_TEMPLATES=1 \ JUCE_COMPILER_SUPPORTS_OVERRIDE_AND_FINAL=1 \ JUCE_COMPILER_SUPPORTS_LAMBDAS=1 \ - JUCE_MODAL_LOOPS_PERMITTED=1 + JUCE_MODAL_LOOPS_PERMITTED=1 \ + JUCE_HAS_CONSTEXPR=1 \ + JUCE_CONSTEXPR=constexpr \ + JUCE_IGNORE_MSVC(warnings)= \ + JUCE_BEGIN_IGNORE_WARNINGS_LEVEL_MSVC(level, warnings)= \ + JUCE_BEGIN_IGNORE_WARNINGS_MSVC(warnings)= \ + JUCE_END_IGNORE_WARNINGS_MSVC= \ + JUCE_BEGIN_IGNORE_WARNINGS_GCC_LIKE(...)= \ + JUCE_END_IGNORE_WARNINGS_GCC_LIKE= \ + JUCE_ENABLE_ALLOCATION_HOOKS=0 # 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 @@ -2398,16 +2438,9 @@ EXTERNAL_GROUPS = YES EXTERNAL_PAGES = YES #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to diagram generator tools #--------------------------------------------------------------------------- -# You can include diagrams made with dia in doxygen documentation. Doxygen will -# then run dia to produce the diagram and insert it in the documentation. The -# DIA_PATH tag allows you to specify the directory where the dia binary resides. -# If left empty dia is assumed to be found in the default search path. - -DIA_PATH = - # If set to YES the inheritance and collaboration graphs will hide inheritance # and usage relations if the target is undocumented or is not a class. # The default value is: YES. @@ -2416,7 +2449,7 @@ HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz (see: -# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent # Bell Labs. The other options in this section have no effect if this option is # set to NO # The default value is: NO. @@ -2469,13 +2502,15 @@ DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" DOT_FONTPATH = -# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a -# graph for each documented class showing the direct and indirect inheritance -# relations. In case HAVE_DOT is set as well dot will be used to draw the graph, -# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set -# to TEXT the direct and indirect inheritance relations will be shown as texts / -# links. -# Possible values are: NO, YES, TEXT and GRAPH. +# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will +# generate a graph for each documented class showing the direct and indirect +# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and +# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case +# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the +# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used. +# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance +# relations will be shown as texts / links. +# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN. # The default value is: YES. CLASS_GRAPH = YES @@ -2616,7 +2651,7 @@ DIR_GRAPH_MAX_DEPTH = 1 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. For an explanation of the image formats see the section # output formats in the documentation of the dot tool (Graphviz (see: -# http://www.graphviz.org/)). +# https://www.graphviz.org/)). # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order # to make the SVG files visible in IE 9+ (other browsers do not have this # requirement). @@ -2653,11 +2688,12 @@ DOT_PATH = DOTFILE_DIRS = -# The MSCFILE_DIRS tag can be used to specify one or more directories that -# contain msc files that are included in the documentation (see the \mscfile -# command). +# You can include diagrams made with dia in doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. -MSCFILE_DIRS = +DIA_PATH = # The DIAFILE_DIRS tag can be used to specify one or more directories that # contain dia files that are included in the documentation (see the \diafile @@ -2734,3 +2770,19 @@ GENERATE_LEGEND = NO # The default value is: YES. DOT_CLEANUP = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will +# use a built-in version of mscgen tool to produce the charts. Alternatively, +# the MSCGEN_TOOL tag can also specify the name an external tool. For instance, +# specifying prog as the value, doxygen will call the tool as prog -T +# -o . The external tool should support +# output file formats "png", "eps", "svg", and "ismap". + +MSCGEN_TOOL = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the \mscfile +# command). + +MSCFILE_DIRS = diff --git a/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h b/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h index a9703ac767..dc89dcc28d 100644 --- a/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h +++ b/modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h @@ -35,6 +35,8 @@ namespace juce It also defines a pitchbend range (in semitones) to be applied for per-note pitchbends and master pitchbends, respectively. + + @tags{Audio} */ struct MPEZone { diff --git a/modules/juce_audio_devices/audio_io/juce_AudioIODevice.h b/modules/juce_audio_devices/audio_io/juce_AudioIODevice.h index 1405f7e29d..da5bfed581 100644 --- a/modules/juce_audio_devices/audio_io/juce_AudioIODevice.h +++ b/modules/juce_audio_devices/audio_io/juce_AudioIODevice.h @@ -25,7 +25,11 @@ namespace juce class AudioIODevice; -/** Additional information that may be passed to the AudioIODeviceCallback. */ +/** + Additional information that may be passed to the AudioIODeviceCallback. + + @tags{Audio} +*/ struct AudioIODeviceCallbackContext { /** If the host provides this information, this field will be set to point to diff --git a/modules/juce_audio_devices/midi_io/juce_MidiDevices.h b/modules/juce_audio_devices/midi_io/juce_MidiDevices.h index e2b416d031..ab90cf0ca1 100644 --- a/modules/juce_audio_devices/midi_io/juce_MidiDevices.h +++ b/modules/juce_audio_devices/midi_io/juce_MidiDevices.h @@ -43,6 +43,8 @@ class MidiDeviceListConnectionBroadcaster; // Stop listening connection.reset(); @endcode + + @tags{Audio} */ class MidiDeviceListConnection { diff --git a/modules/juce_audio_processors/format_types/juce_ARAHosting.h b/modules/juce_audio_processors/format_types/juce_ARAHosting.h index 08862331a2..9da806df08 100644 --- a/modules/juce_audio_processors/format_types/juce_ARAHosting.h +++ b/modules/juce_audio_processors/format_types/juce_ARAHosting.h @@ -107,6 +107,8 @@ struct ConversionFunctions when the lifetime of the helper class object ends. You shouldn't use this class directly but instead inherit from the helper classes. + + @tags{ARA} */ template class ManagedARAHandle @@ -279,6 +281,8 @@ private: /** This class is used internally by PlaybackRegionRegistry to be notified when a PlaybackRegion object is deleted. + + @tags{ARA} */ struct DeletionListener { @@ -653,6 +657,8 @@ using EditorRendererInterface = PlaybackRegionRegistry {}; diff --git a/modules/juce_audio_processors/utilities/juce_AudioParameterChoice.h b/modules/juce_audio_processors/utilities/juce_AudioParameterChoice.h index f3fdd2d641..6940a57d00 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioParameterChoice.h +++ b/modules/juce_audio_processors/utilities/juce_AudioParameterChoice.h @@ -29,6 +29,8 @@ namespace juce /** Properties of an AudioParameterChoice. @see AudioParameterChoice(), RangedAudioParameterAttributes() + + @tags{Audio} */ class AudioParameterChoiceAttributes : public RangedAudioParameterAttributes {}; diff --git a/modules/juce_audio_processors/utilities/juce_AudioParameterFloat.h b/modules/juce_audio_processors/utilities/juce_AudioParameterFloat.h index c6adbe78f6..c785f340e2 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioParameterFloat.h +++ b/modules/juce_audio_processors/utilities/juce_AudioParameterFloat.h @@ -29,6 +29,8 @@ namespace juce /** Properties of an AudioParameterFloat. @see AudioParameterFloat(), RangedAudioParameterAttributes() + + @tags{Audio} */ class AudioParameterFloatAttributes : public RangedAudioParameterAttributes {}; diff --git a/modules/juce_audio_processors/utilities/juce_AudioParameterInt.h b/modules/juce_audio_processors/utilities/juce_AudioParameterInt.h index 965dac6a40..87036c24ab 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioParameterInt.h +++ b/modules/juce_audio_processors/utilities/juce_AudioParameterInt.h @@ -29,6 +29,8 @@ namespace juce /** Properties of an AudioParameterInt. @see AudioParameterInt(), RangedAudioParameterAttributes() + + @tags{Audio} */ class AudioParameterIntAttributes : public RangedAudioParameterAttributes {}; diff --git a/modules/juce_audio_processors/utilities/juce_AudioProcessorParameterWithID.h b/modules/juce_audio_processors/utilities/juce_AudioProcessorParameterWithID.h index 15f7882c9f..c5a622d269 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioProcessorParameterWithID.h +++ b/modules/juce_audio_processors/utilities/juce_AudioProcessorParameterWithID.h @@ -28,6 +28,8 @@ namespace juce /** Combines a parameter ID and a version hint. + + @tags{Audio} */ class ParameterID { @@ -62,6 +64,8 @@ private: /** An instance of this class may be passed to the constructor of an AudioProcessorParameterWithID to set optional characteristics of that parameter. + + @tags{Audio} */ class AudioProcessorParameterWithIDAttributes { diff --git a/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h b/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h index a6e0de3947..83d93962eb 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h +++ b/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h @@ -32,6 +32,8 @@ namespace juce AudioParameterFloatAttributes. @see AudioParameterFloatAttributes, RangedAudioParameterAttributes + + @tags{Audio} */ class AudioProcessorValueTreeStateParameterAttributes { diff --git a/modules/juce_audio_processors/utilities/juce_NativeScaleFactorNotifier.h b/modules/juce_audio_processors/utilities/juce_NativeScaleFactorNotifier.h index a755fb2def..597513eef0 100644 --- a/modules/juce_audio_processors/utilities/juce_NativeScaleFactorNotifier.h +++ b/modules/juce_audio_processors/utilities/juce_NativeScaleFactorNotifier.h @@ -31,6 +31,8 @@ namespace juce This is used in the VST and VST3 wrappers to ensure that the editor's scale is kept in sync with the scale of its containing component. + + @tags{GUI} */ class NativeScaleFactorNotifier : private ComponentMovementWatcher, private ComponentPeer::ScaleFactorListener diff --git a/modules/juce_audio_processors/utilities/juce_RangedAudioParameter.h b/modules/juce_audio_processors/utilities/juce_RangedAudioParameter.h index c24c52b94d..4707e8f53a 100644 --- a/modules/juce_audio_processors/utilities/juce_RangedAudioParameter.h +++ b/modules/juce_audio_processors/utilities/juce_RangedAudioParameter.h @@ -36,6 +36,8 @@ namespace juce i.e. the identifiers AudioParameterFloatAttributes and RangedAudioParameterAttributes should not be interchangable because we might need to add float-specific attributes in the future. Users should not refer directly to RangedAudioParameterAttributes. + + @tags{Audio} */ template class RangedAudioParameterAttributes diff --git a/modules/juce_core/containers/juce_Optional.h b/modules/juce_core/containers/juce_Optional.h index b7609278e3..bbcce34785 100644 --- a/modules/juce_core/containers/juce_Optional.h +++ b/modules/juce_core/containers/juce_Optional.h @@ -30,7 +30,9 @@ constexpr auto nullopt = std::nullopt; // link time code generation. JUCE_BEGIN_IGNORE_WARNINGS_MSVC (4702) +#ifndef DOXYGEN #define JUCE_OPTIONAL_OPERATORS X(==) X(!=) X(<) X(<=) X(>) X(>=) +#endif /** A simple optional type. @@ -161,6 +163,7 @@ Optional> makeOptional (Value&& v) return std::forward (v); } +#ifndef DOXYGEN #define X(op) \ template bool operator op (const Optional& lhs, const Optional& rhs) { return lhs.opt op rhs.opt; } \ template bool operator op (const Optional& lhs, Nullopt rhs) { return lhs.opt op rhs; } \ @@ -171,7 +174,7 @@ Optional> makeOptional (Value&& v) JUCE_OPTIONAL_OPERATORS #undef X - #undef JUCE_OPTIONAL_OPERATORS +#endif } // namespace juce diff --git a/modules/juce_core/containers/juce_Span.h b/modules/juce_core/containers/juce_Span.h index cf66ca8336..00712e6f38 100644 --- a/modules/juce_core/containers/juce_Span.h +++ b/modules/juce_core/containers/juce_Span.h @@ -88,6 +88,8 @@ namespace detail or other similar container. This is a bit like std::span from C++20, but with a more limited interface. + + @tags{Core} */ template class Span : private detail::NumBase // for empty-base optimisation diff --git a/modules/juce_core/files/juce_common_MimeTypes.h b/modules/juce_core/files/juce_common_MimeTypes.h index d3b3e7be9c..4b6437a29b 100644 --- a/modules/juce_core/files/juce_common_MimeTypes.h +++ b/modules/juce_core/files/juce_common_MimeTypes.h @@ -28,18 +28,17 @@ namespace juce { +/** @internal */ struct MimeTypeTable { - -/* @internal */ +/** @internal */ static void registerCustomMimeTypeForFileExtension (const String& mimeType, const String& fileExtension); -/* @internal */ +/** @internal */ static StringArray getMimeTypesForFileExtension (const String& fileExtension); -/* @internal */ +/** @internal */ static StringArray getFileExtensionsForMimeType (const String& mimeType); - }; } // namespace juce diff --git a/modules/juce_core/memory/juce_Reservoir.h b/modules/juce_core/memory/juce_Reservoir.h index 3829f73e41..6d7fe94b5d 100644 --- a/modules/juce_core/memory/juce_Reservoir.h +++ b/modules/juce_core/memory/juce_Reservoir.h @@ -25,6 +25,8 @@ namespace juce /** Helper functions for managing buffered readers. + + @tags{Audio} */ struct Reservoir { diff --git a/modules/juce_core/misc/juce_Functional.h b/modules/juce_core/misc/juce_Functional.h index 7f20239a61..040132f7f0 100644 --- a/modules/juce_core/misc/juce_Functional.h +++ b/modules/juce_core/misc/juce_Functional.h @@ -109,6 +109,8 @@ template struct ScopeGuard : Fn { ~ScopeGuard() { Fn::operator()(); } }; template ScopeGuard (Fn) -> ScopeGuard; diff --git a/modules/juce_graphics/images/juce_ScaledImage.h b/modules/juce_graphics/images/juce_ScaledImage.h index fac2145360..9dfd7c0376 100644 --- a/modules/juce_graphics/images/juce_ScaledImage.h +++ b/modules/juce_graphics/images/juce_ScaledImage.h @@ -40,6 +40,8 @@ namespace juce The ScaledImage class is designed to store an image alongside a scale factor that informs a renderer how to convert between the image's pixels and points. + + @tags{GUI} */ class JUCE_API ScaledImage { diff --git a/modules/juce_gui_basics/accessibility/interfaces/juce_AccessibilityTableInterface.h b/modules/juce_gui_basics/accessibility/interfaces/juce_AccessibilityTableInterface.h index a50227ed28..2d08cf6a92 100644 --- a/modules/juce_gui_basics/accessibility/interfaces/juce_AccessibilityTableInterface.h +++ b/modules/juce_gui_basics/accessibility/interfaces/juce_AccessibilityTableInterface.h @@ -65,6 +65,7 @@ public: */ virtual const AccessibilityHandler* getHeaderHandler() const = 0; + /** A simple span of elements. */ struct Span { int begin, num; }; /** Given the handler of one of the cells in the table, returns the rows covered diff --git a/modules/juce_gui_basics/windows/juce_ScopedMessageBox.h b/modules/juce_gui_basics/windows/juce_ScopedMessageBox.h index bd2cba7b0c..85fa52156c 100644 --- a/modules/juce_gui_basics/windows/juce_ScopedMessageBox.h +++ b/modules/juce_gui_basics/windows/juce_ScopedMessageBox.h @@ -30,6 +30,8 @@ namespace juce Objects of this type can be used to programmatically close message boxes. @see NativeMessageBox::showScopedAsync(), AlertWindow::showScopedAsync() + + @tags{GUI} */ class ScopedMessageBox { diff --git a/modules/juce_gui_basics/windows/juce_VBlankAttachement.h b/modules/juce_gui_basics/windows/juce_VBlankAttachement.h index 19514eb2e7..2245b54c15 100644 --- a/modules/juce_gui_basics/windows/juce_VBlankAttachement.h +++ b/modules/juce_gui_basics/windows/juce_VBlankAttachement.h @@ -26,8 +26,11 @@ namespace juce { -/** Helper class to synchronise Component updates to the vertical blank event of the display that +/** + Helper class to synchronise Component updates to the vertical blank event of the display that the Component is presented on. This is useful when animating the Component's contents. + + @tags{GUI} */ class JUCE_API VBlankAttachment final : public ComponentPeer::VBlankListener, public ComponentListener diff --git a/modules/juce_gui_basics/windows/juce_WindowUtils.h b/modules/juce_gui_basics/windows/juce_WindowUtils.h index d2849fb6e7..94641e2338 100644 --- a/modules/juce_gui_basics/windows/juce_WindowUtils.h +++ b/modules/juce_gui_basics/windows/juce_WindowUtils.h @@ -26,6 +26,11 @@ namespace juce { +/** + Windowing helper functions. + + @tags{GUI} +*/ struct WindowUtils { WindowUtils() = delete; diff --git a/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h b/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h index 8720f6825d..9423e25f15 100644 --- a/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h +++ b/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h @@ -46,6 +46,9 @@ class JUCE_API WebBrowserComponent : public Component { public: //============================================================================== + /** + Options to configure WebBrowserComponent. + */ class JUCE_API Options { public: