Browse Source

Doxygen: Fix some Doxygen issues

v7.0.9
Tom Poole 2 years ago
parent
commit
ff835be2ac
25 changed files with 170 additions and 59 deletions
  1. +103
    -51
      docs/doxygen/Doxyfile
  2. +2
    -0
      modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h
  3. +5
    -1
      modules/juce_audio_devices/audio_io/juce_AudioIODevice.h
  4. +2
    -0
      modules/juce_audio_devices/midi_io/juce_MidiDevices.h
  5. +6
    -0
      modules/juce_audio_processors/format_types/juce_ARAHosting.h
  6. +3
    -0
      modules/juce_audio_processors/format_types/juce_LV2SupportLibs.cpp
  7. +2
    -0
      modules/juce_audio_processors/utilities/juce_AudioParameterBool.h
  8. +2
    -0
      modules/juce_audio_processors/utilities/juce_AudioParameterChoice.h
  9. +2
    -0
      modules/juce_audio_processors/utilities/juce_AudioParameterFloat.h
  10. +2
    -0
      modules/juce_audio_processors/utilities/juce_AudioParameterInt.h
  11. +4
    -0
      modules/juce_audio_processors/utilities/juce_AudioProcessorParameterWithID.h
  12. +2
    -0
      modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h
  13. +2
    -0
      modules/juce_audio_processors/utilities/juce_NativeScaleFactorNotifier.h
  14. +2
    -0
      modules/juce_audio_processors/utilities/juce_RangedAudioParameter.h
  15. +4
    -1
      modules/juce_core/containers/juce_Optional.h
  16. +2
    -0
      modules/juce_core/containers/juce_Span.h
  17. +4
    -5
      modules/juce_core/files/juce_common_MimeTypes.h
  18. +2
    -0
      modules/juce_core/memory/juce_Reservoir.h
  19. +2
    -0
      modules/juce_core/misc/juce_Functional.h
  20. +2
    -0
      modules/juce_graphics/images/juce_ScaledImage.h
  21. +1
    -0
      modules/juce_gui_basics/accessibility/interfaces/juce_AccessibilityTableInterface.h
  22. +2
    -0
      modules/juce_gui_basics/windows/juce_ScopedMessageBox.h
  23. +4
    -1
      modules/juce_gui_basics/windows/juce_VBlankAttachement.h
  24. +5
    -0
      modules/juce_gui_basics/windows/juce_WindowUtils.h
  25. +3
    -0
      modules/juce_gui_extra/misc/juce_WebBrowserComponent.h

+ 103
- 51
docs/doxygen/Doxyfile View File

@@ -1,4 +1,4 @@
# Doxyfile 1.9.6
# Doxyfile 1.9.8


# This file describes the settings to be used by the documentation system # This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project. # doxygen (www.doxygen.org) for a project.
@@ -374,6 +374,17 @@ MARKDOWN_SUPPORT = YES


TOC_INCLUDE_HEADINGS = 0 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 # When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can # 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 # 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 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 # 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. # will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO. # The default value is: NO.


INTERNAL_DOCS = YES
INTERNAL_DOCS = NO


# With the correct setting of option CASE_SENSE_NAMES doxygen will better be # 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 # 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 # 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 # 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. # 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. # The default value is: NO.


WARN_AS_ERROR = 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 # output. The symbol name can be a fully qualified name, a word, or if the
# wildcard * is used, a substring. Examples: ANamespace, AClass, # wildcard * is used, a substring. Examples: ANamespace, AClass,
# ANamespace::AClass, ANamespace::*Test # 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 # 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 # that contain example code fragments that are included (see the \include
@@ -1371,15 +1394,6 @@ HTML_COLORSTYLE_SAT = 100


HTML_COLORSTYLE_GAMMA = 80 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 # 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 # documentation will contain a main index with vertical navigation menus that
# are dynamically created via JavaScript. If disabled, the navigation index will # are dynamically created via JavaScript. If disabled, the navigation index will
@@ -1399,6 +1413,14 @@ HTML_DYNAMIC_MENUS = NO


HTML_DYNAMIC_SECTIONS = 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 # 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 # shown in the various tree structured indices initially; the user can expand
# and collapse entries dynamically later on. Doxygen will expand the tree to # and collapse entries dynamically later on. Doxygen will expand the tree to
@@ -1529,6 +1551,16 @@ BINARY_TOC = NO


TOC_EXPAND = 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 # 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 # 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 # 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 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 <return> 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. # The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES. # This tag requires that the tag GENERATE_LATEX is set to YES.


@@ -2040,14 +2079,6 @@ LATEX_HIDE_INDICES = NO


LATEX_BIB_STYLE = plain 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) # 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, # 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 # 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 # 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 # the structure of the code including all documentation. Note that this feature
# is still experimental and incomplete at the moment. # is still experimental and incomplete at the moment.
# The default value is: NO. # The default value is: NO.
@@ -2275,7 +2306,7 @@ ENABLE_PREPROCESSING = YES
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # 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 # 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 # 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_VARIADIC_TEMPLATES=1 \
JUCE_COMPILER_SUPPORTS_OVERRIDE_AND_FINAL=1 \ JUCE_COMPILER_SUPPORTS_OVERRIDE_AND_FINAL=1 \
JUCE_COMPILER_SUPPORTS_LAMBDAS=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 # 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 # 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 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 # 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. # and usage relations if the target is undocumented or is not a class.
# The default value is: YES. # 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 # 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: # 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 # Bell Labs. The other options in this section have no effect if this option is
# set to NO # set to NO
# The default value is: NO. # The default value is: NO.
@@ -2469,13 +2502,15 @@ DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"


DOT_FONTPATH = 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. # The default value is: YES.


CLASS_GRAPH = 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 # 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 # generated by dot. For an explanation of the image formats see the section
# output formats in the documentation of the dot tool (Graphviz (see: # 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 # 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 # to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement). # requirement).
@@ -2653,11 +2688,12 @@ DOT_PATH =


DOTFILE_DIRS = 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 # 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 # contain dia files that are included in the documentation (see the \diafile
@@ -2734,3 +2770,19 @@ GENERATE_LEGEND = NO
# The default value is: YES. # The default value is: YES.


DOT_CLEANUP = 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
# <outfile_format> -o <outputfile> <inputfile>. 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 =

+ 2
- 0
modules/juce_audio_basics/mpe/juce_MPEZoneLayout.h View File

@@ -35,6 +35,8 @@ namespace juce
It also defines a pitchbend range (in semitones) to be applied for per-note pitchbends and It also defines a pitchbend range (in semitones) to be applied for per-note pitchbends and
master pitchbends, respectively. master pitchbends, respectively.
@tags{Audio}
*/ */
struct MPEZone struct MPEZone
{ {


+ 5
- 1
modules/juce_audio_devices/audio_io/juce_AudioIODevice.h View File

@@ -25,7 +25,11 @@ namespace juce
class AudioIODevice; class AudioIODevice;
/** Additional information that may be passed to the AudioIODeviceCallback. */
/**
Additional information that may be passed to the AudioIODeviceCallback.
@tags{Audio}
*/
struct AudioIODeviceCallbackContext struct AudioIODeviceCallbackContext
{ {
/** If the host provides this information, this field will be set to point to /** If the host provides this information, this field will be set to point to


+ 2
- 0
modules/juce_audio_devices/midi_io/juce_MidiDevices.h View File

@@ -43,6 +43,8 @@ class MidiDeviceListConnectionBroadcaster;
// Stop listening // Stop listening
connection.reset(); connection.reset();
@endcode @endcode
@tags{Audio}
*/ */
class MidiDeviceListConnection class MidiDeviceListConnection
{ {


+ 6
- 0
modules/juce_audio_processors/format_types/juce_ARAHosting.h View File

@@ -107,6 +107,8 @@ struct ConversionFunctions
when the lifetime of the helper class object ends. when the lifetime of the helper class object ends.
You shouldn't use this class directly but instead inherit from the helper classes. You shouldn't use this class directly but instead inherit from the helper classes.
@tags{ARA}
*/ */
template <typename Base, typename PtrIn> template <typename Base, typename PtrIn>
class ManagedARAHandle class ManagedARAHandle
@@ -279,6 +281,8 @@ private:
/** This class is used internally by PlaybackRegionRegistry to be notified when a PlaybackRegion /** This class is used internally by PlaybackRegionRegistry to be notified when a PlaybackRegion
object is deleted. object is deleted.
@tags{ARA}
*/ */
struct DeletionListener struct DeletionListener
{ {
@@ -653,6 +657,8 @@ using EditorRendererInterface = PlaybackRegionRegistry<ARA::ARAEditorRendererR
Returned by ARAHostDocumentController::bindDocumentToPluginInstance(). The corresponding Returned by ARAHostDocumentController::bindDocumentToPluginInstance(). The corresponding
ARAHostDocumentController must remain valid as long as the plugin extension is in use. ARAHostDocumentController must remain valid as long as the plugin extension is in use.
@tags{ARA}
*/ */
class PlugInExtensionInstance final class PlugInExtensionInstance final
{ {


+ 3
- 0
modules/juce_audio_processors/format_types/juce_LV2SupportLibs.cpp View File

@@ -116,3 +116,6 @@ using namespace Utils;
#pragma pop_macro ("nil") #pragma pop_macro ("nil")
} // extern "C" } // extern "C"
JUCE_END_IGNORE_WARNINGS_MSVC
JUCE_END_IGNORE_WARNINGS_GCC_LIKE

+ 2
- 0
modules/juce_audio_processors/utilities/juce_AudioParameterBool.h View File

@@ -29,6 +29,8 @@ namespace juce
/** Properties of an AudioParameterBool. /** Properties of an AudioParameterBool.
@see AudioParameterBool(), RangedAudioParameterAttributes() @see AudioParameterBool(), RangedAudioParameterAttributes()
@tags{Audio}
*/ */
class AudioParameterBoolAttributes : public RangedAudioParameterAttributes<AudioParameterBoolAttributes, bool> {}; class AudioParameterBoolAttributes : public RangedAudioParameterAttributes<AudioParameterBoolAttributes, bool> {};


+ 2
- 0
modules/juce_audio_processors/utilities/juce_AudioParameterChoice.h View File

@@ -29,6 +29,8 @@ namespace juce
/** Properties of an AudioParameterChoice. /** Properties of an AudioParameterChoice.
@see AudioParameterChoice(), RangedAudioParameterAttributes() @see AudioParameterChoice(), RangedAudioParameterAttributes()
@tags{Audio}
*/ */
class AudioParameterChoiceAttributes : public RangedAudioParameterAttributes<AudioParameterChoiceAttributes, int> {}; class AudioParameterChoiceAttributes : public RangedAudioParameterAttributes<AudioParameterChoiceAttributes, int> {};


+ 2
- 0
modules/juce_audio_processors/utilities/juce_AudioParameterFloat.h View File

@@ -29,6 +29,8 @@ namespace juce
/** Properties of an AudioParameterFloat. /** Properties of an AudioParameterFloat.
@see AudioParameterFloat(), RangedAudioParameterAttributes() @see AudioParameterFloat(), RangedAudioParameterAttributes()
@tags{Audio}
*/ */
class AudioParameterFloatAttributes : public RangedAudioParameterAttributes<AudioParameterFloatAttributes, float> {}; class AudioParameterFloatAttributes : public RangedAudioParameterAttributes<AudioParameterFloatAttributes, float> {};


+ 2
- 0
modules/juce_audio_processors/utilities/juce_AudioParameterInt.h View File

@@ -29,6 +29,8 @@ namespace juce
/** Properties of an AudioParameterInt. /** Properties of an AudioParameterInt.
@see AudioParameterInt(), RangedAudioParameterAttributes() @see AudioParameterInt(), RangedAudioParameterAttributes()
@tags{Audio}
*/ */
class AudioParameterIntAttributes : public RangedAudioParameterAttributes<AudioParameterIntAttributes, int> {}; class AudioParameterIntAttributes : public RangedAudioParameterAttributes<AudioParameterIntAttributes, int> {};


+ 4
- 0
modules/juce_audio_processors/utilities/juce_AudioProcessorParameterWithID.h View File

@@ -28,6 +28,8 @@ namespace juce
/** /**
Combines a parameter ID and a version hint. Combines a parameter ID and a version hint.
@tags{Audio}
*/ */
class ParameterID class ParameterID
{ {
@@ -62,6 +64,8 @@ private:
/** /**
An instance of this class may be passed to the constructor of an AudioProcessorParameterWithID An instance of this class may be passed to the constructor of an AudioProcessorParameterWithID
to set optional characteristics of that parameter. to set optional characteristics of that parameter.
@tags{Audio}
*/ */
class AudioProcessorParameterWithIDAttributes class AudioProcessorParameterWithIDAttributes
{ {


+ 2
- 0
modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h View File

@@ -32,6 +32,8 @@ namespace juce
AudioParameterFloatAttributes. AudioParameterFloatAttributes.
@see AudioParameterFloatAttributes, RangedAudioParameterAttributes @see AudioParameterFloatAttributes, RangedAudioParameterAttributes
@tags{Audio}
*/ */
class AudioProcessorValueTreeStateParameterAttributes class AudioProcessorValueTreeStateParameterAttributes
{ {


+ 2
- 0
modules/juce_audio_processors/utilities/juce_NativeScaleFactorNotifier.h View File

@@ -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 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. the scale of its containing component.
@tags{GUI}
*/ */
class NativeScaleFactorNotifier : private ComponentMovementWatcher, class NativeScaleFactorNotifier : private ComponentMovementWatcher,
private ComponentPeer::ScaleFactorListener private ComponentPeer::ScaleFactorListener


+ 2
- 0
modules/juce_audio_processors/utilities/juce_RangedAudioParameter.h View File

@@ -36,6 +36,8 @@ namespace juce
i.e. the identifiers AudioParameterFloatAttributes and RangedAudioParameterAttributes<float> i.e. the identifiers AudioParameterFloatAttributes and RangedAudioParameterAttributes<float>
should not be interchangable because we might need to add float-specific attributes in should not be interchangable because we might need to add float-specific attributes in
the future. Users should not refer directly to RangedAudioParameterAttributes. the future. Users should not refer directly to RangedAudioParameterAttributes.
@tags{Audio}
*/ */
template <typename Derived, typename Value> template <typename Derived, typename Value>
class RangedAudioParameterAttributes class RangedAudioParameterAttributes


+ 4
- 1
modules/juce_core/containers/juce_Optional.h View File

@@ -30,7 +30,9 @@ constexpr auto nullopt = std::nullopt;
// link time code generation. // link time code generation.
JUCE_BEGIN_IGNORE_WARNINGS_MSVC (4702) JUCE_BEGIN_IGNORE_WARNINGS_MSVC (4702)
#ifndef DOXYGEN
#define JUCE_OPTIONAL_OPERATORS X(==) X(!=) X(<) X(<=) X(>) X(>=) #define JUCE_OPTIONAL_OPERATORS X(==) X(!=) X(<) X(<=) X(>) X(>=)
#endif
/** /**
A simple optional type. A simple optional type.
@@ -161,6 +163,7 @@ Optional<std::decay_t<Value>> makeOptional (Value&& v)
return std::forward<Value> (v); return std::forward<Value> (v);
} }
#ifndef DOXYGEN
#define X(op) \ #define X(op) \
template <typename T, typename U> bool operator op (const Optional<T>& lhs, const Optional<U>& rhs) { return lhs.opt op rhs.opt; } \ template <typename T, typename U> bool operator op (const Optional<T>& lhs, const Optional<U>& rhs) { return lhs.opt op rhs.opt; } \
template <typename T> bool operator op (const Optional<T>& lhs, Nullopt rhs) { return lhs.opt op rhs; } \ template <typename T> bool operator op (const Optional<T>& lhs, Nullopt rhs) { return lhs.opt op rhs; } \
@@ -171,7 +174,7 @@ Optional<std::decay_t<Value>> makeOptional (Value&& v)
JUCE_OPTIONAL_OPERATORS JUCE_OPTIONAL_OPERATORS
#undef X #undef X
#undef JUCE_OPTIONAL_OPERATORS #undef JUCE_OPTIONAL_OPERATORS
#endif
} // namespace juce } // namespace juce

+ 2
- 0
modules/juce_core/containers/juce_Span.h View File

@@ -88,6 +88,8 @@ namespace detail
or other similar container. or other similar container.
This is a bit like std::span from C++20, but with a more limited interface. This is a bit like std::span from C++20, but with a more limited interface.
@tags{Core}
*/ */
template <typename Value, size_t Extent = dynamicExtent> template <typename Value, size_t Extent = dynamicExtent>
class Span : private detail::NumBase<Extent> // for empty-base optimisation class Span : private detail::NumBase<Extent> // for empty-base optimisation


+ 4
- 5
modules/juce_core/files/juce_common_MimeTypes.h View File

@@ -28,18 +28,17 @@
namespace juce namespace juce
{ {
/** @internal */
struct MimeTypeTable struct MimeTypeTable
{ {
/* @internal */
/** @internal */
static void registerCustomMimeTypeForFileExtension (const String& mimeType, const String& fileExtension); static void registerCustomMimeTypeForFileExtension (const String& mimeType, const String& fileExtension);
/* @internal */
/** @internal */
static StringArray getMimeTypesForFileExtension (const String& fileExtension); static StringArray getMimeTypesForFileExtension (const String& fileExtension);
/* @internal */
/** @internal */
static StringArray getFileExtensionsForMimeType (const String& mimeType); static StringArray getFileExtensionsForMimeType (const String& mimeType);
}; };
} // namespace juce } // namespace juce

+ 2
- 0
modules/juce_core/memory/juce_Reservoir.h View File

@@ -25,6 +25,8 @@ namespace juce
/** /**
Helper functions for managing buffered readers. Helper functions for managing buffered readers.
@tags{Audio}
*/ */
struct Reservoir struct Reservoir
{ {


+ 2
- 0
modules/juce_core/misc/juce_Functional.h View File

@@ -109,6 +109,8 @@ template <typename Object, typename OtherObject, typename Member, typename Other
doWorkHavingEstablishedPreconditions(); doWorkHavingEstablishedPreconditions();
} // ...or here! } // ...or here!
@endcode @endcode
@tags{Core}
*/ */
template <typename Fn> struct ScopeGuard : Fn { ~ScopeGuard() { Fn::operator()(); } }; template <typename Fn> struct ScopeGuard : Fn { ~ScopeGuard() { Fn::operator()(); } };
template <typename Fn> ScopeGuard (Fn) -> ScopeGuard<Fn>; template <typename Fn> ScopeGuard (Fn) -> ScopeGuard<Fn>;


+ 2
- 0
modules/juce_graphics/images/juce_ScaledImage.h View File

@@ -40,6 +40,8 @@ namespace juce
The ScaledImage class is designed to store an image alongside a scale 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 factor that informs a renderer how to convert between the image's pixels
and points. and points.
@tags{GUI}
*/ */
class JUCE_API ScaledImage class JUCE_API ScaledImage
{ {


+ 1
- 0
modules/juce_gui_basics/accessibility/interfaces/juce_AccessibilityTableInterface.h View File

@@ -65,6 +65,7 @@ public:
*/ */
virtual const AccessibilityHandler* getHeaderHandler() const = 0; virtual const AccessibilityHandler* getHeaderHandler() const = 0;
/** A simple span of elements. */
struct Span { int begin, num; }; struct Span { int begin, num; };
/** Given the handler of one of the cells in the table, returns the rows covered /** Given the handler of one of the cells in the table, returns the rows covered


+ 2
- 0
modules/juce_gui_basics/windows/juce_ScopedMessageBox.h View File

@@ -30,6 +30,8 @@ namespace juce
Objects of this type can be used to programmatically close message boxes. Objects of this type can be used to programmatically close message boxes.
@see NativeMessageBox::showScopedAsync(), AlertWindow::showScopedAsync() @see NativeMessageBox::showScopedAsync(), AlertWindow::showScopedAsync()
@tags{GUI}
*/ */
class ScopedMessageBox class ScopedMessageBox
{ {


+ 4
- 1
modules/juce_gui_basics/windows/juce_VBlankAttachement.h View File

@@ -26,8 +26,11 @@
namespace juce 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. the Component is presented on. This is useful when animating the Component's contents.
@tags{GUI}
*/ */
class JUCE_API VBlankAttachment final : public ComponentPeer::VBlankListener, class JUCE_API VBlankAttachment final : public ComponentPeer::VBlankListener,
public ComponentListener public ComponentListener


+ 5
- 0
modules/juce_gui_basics/windows/juce_WindowUtils.h View File

@@ -26,6 +26,11 @@
namespace juce namespace juce
{ {
/**
Windowing helper functions.
@tags{GUI}
*/
struct WindowUtils struct WindowUtils
{ {
WindowUtils() = delete; WindowUtils() = delete;


+ 3
- 0
modules/juce_gui_extra/misc/juce_WebBrowserComponent.h View File

@@ -46,6 +46,9 @@ class JUCE_API WebBrowserComponent : public Component
{ {
public: public:
//============================================================================== //==============================================================================
/**
Options to configure WebBrowserComponent.
*/
class JUCE_API Options class JUCE_API Options
{ {
public: public:


Loading…
Cancel
Save