From 05b036272a89a01c8712e717fc9661c46a749ef1 Mon Sep 17 00:00:00 2001 From: Tom Poole Date: Wed, 12 Jun 2024 08:50:39 +0100 Subject: [PATCH] Fix some Doxygen docstrings --- modules/juce_animation/animation/juce_Easings.h | 5 ++++- modules/juce_core/misc/juce_OptionsHelpers.h | 4 ++++ .../juce_graphics/fonts/juce_FunctionPointerDestructor.h | 4 ++++ modules/juce_graphics/fonts/juce_LruCache.h | 4 ++++ modules/juce_graphics/fonts/juce_Typeface.h | 9 +++++++++ modules/juce_graphics/fonts/juce_TypefaceFileCache.h | 4 ++++ modules/juce_gui_basics/widgets/juce_Slider.h | 2 ++ modules/juce_gui_extra/misc/juce_WebBrowserComponent.h | 2 ++ .../misc/juce_WebControlParameterIndexReceiver.h | 2 ++ modules/juce_gui_extra/misc/juce_WebControlRelays.h | 6 ++++++ 10 files changed, 41 insertions(+), 1 deletion(-) diff --git a/modules/juce_animation/animation/juce_Easings.h b/modules/juce_animation/animation/juce_Easings.h index c3d25fe668b9..06298144e65f 100644 --- a/modules/juce_animation/animation/juce_Easings.h +++ b/modules/juce_animation/animation/juce_Easings.h @@ -36,7 +36,10 @@ namespace juce { //============================================================================== -/** A selection of options available for customising a spring style easing function. */ +/** A selection of options available for customising a spring style easing function. + + @tags{Animations} +*/ class SpringEasingOptions { public: diff --git a/modules/juce_core/misc/juce_OptionsHelpers.h b/modules/juce_core/misc/juce_OptionsHelpers.h index 55760f9f0011..883d742229dc 100644 --- a/modules/juce_core/misc/juce_OptionsHelpers.h +++ b/modules/juce_core/misc/juce_OptionsHelpers.h @@ -32,6 +32,10 @@ ============================================================================== */ +/** A base class for building Options. + + @tags{Core} +*/ template class OptionsBuilder { diff --git a/modules/juce_graphics/fonts/juce_FunctionPointerDestructor.h b/modules/juce_graphics/fonts/juce_FunctionPointerDestructor.h index cb942e80963c..8855d1f97404 100644 --- a/modules/juce_graphics/fonts/juce_FunctionPointerDestructor.h +++ b/modules/juce_graphics/fonts/juce_FunctionPointerDestructor.h @@ -32,6 +32,8 @@ ============================================================================== */ +#ifndef DOXYGEN + namespace juce { @@ -47,3 +49,5 @@ struct FunctionPointerDestructor }; } // namespace juce + +#endif diff --git a/modules/juce_graphics/fonts/juce_LruCache.h b/modules/juce_graphics/fonts/juce_LruCache.h index cf50c7a66c7d..213a86ed700e 100644 --- a/modules/juce_graphics/fonts/juce_LruCache.h +++ b/modules/juce_graphics/fonts/juce_LruCache.h @@ -32,6 +32,8 @@ ============================================================================== */ +#ifndef DOXYGEN + namespace juce { @@ -82,3 +84,5 @@ class LruCache }; } // namespace juce + +#endif diff --git a/modules/juce_graphics/fonts/juce_Typeface.h b/modules/juce_graphics/fonts/juce_Typeface.h index 31c4b39a9c0c..dedfee1b3b48 100644 --- a/modules/juce_graphics/fonts/juce_Typeface.h +++ b/modules/juce_graphics/fonts/juce_Typeface.h @@ -37,6 +37,8 @@ namespace juce /** A single path-based layer of a colour glyph. Contains the glyph shape and the colour in which the shape should be painted. + + @tags{Graphics} */ struct ColourLayer { @@ -45,6 +47,8 @@ struct ColourLayer }; /** A bitmap representing (part of) a glyph, most commonly used to represent colour emoji glyphs. + + @tags{Graphics} */ struct ImageLayer { @@ -53,6 +57,8 @@ struct ImageLayer }; /** A single layer that makes up part of a glyph image. + + @tags{Graphics} */ struct GlyphLayer { @@ -85,6 +91,8 @@ enum class TypefaceMetricsKind }; /** Font metrics using JUCE conventions. + + @tags{Graphics} */ struct TypefaceMetrics { @@ -280,6 +288,7 @@ class JUCE_API Typeface : public ReferenceCountedObject const auto isMonochrome = typeface->getColourGlyphFormats() == 0; const auto isSvg = (typeface->getColourGlyphFormats() & Typeface::colourGlyphFormatSvg) != 0; const auto isSimpleColour = (typeface->getColourGlyphFormats() & (Typeface::colourGlyphFormatBitmap | Typeface::colourGlyphFormatCOLRv0)) != 0; + @endcode */ int getColourGlyphFormats() const; diff --git a/modules/juce_graphics/fonts/juce_TypefaceFileCache.h b/modules/juce_graphics/fonts/juce_TypefaceFileCache.h index 4e47c464e592..98fc18050b1d 100644 --- a/modules/juce_graphics/fonts/juce_TypefaceFileCache.h +++ b/modules/juce_graphics/fonts/juce_TypefaceFileCache.h @@ -32,6 +32,8 @@ ============================================================================== */ +#ifndef DOXYGEN + namespace juce { @@ -68,3 +70,5 @@ class TypefaceFileCache : public DeletedAtShutdown JUCE_IMPLEMENT_SINGLETON (TypefaceFileCache) } // namespace juce + +#endif diff --git a/modules/juce_gui_basics/widgets/juce_Slider.h b/modules/juce_gui_basics/widgets/juce_Slider.h index fc588c33bd99..57aab5fd64b1 100644 --- a/modules/juce_gui_basics/widgets/juce_Slider.h +++ b/modules/juce_gui_basics/widgets/juce_Slider.h @@ -42,6 +42,8 @@ namespace juce @see Slider::addListener, Slider::removeListener, WebSliderRelay::addListener, WebSliderRelay::removeListener + + @tags{GUI} */ template class JUCE_API SliderListener diff --git a/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h b/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h index a2235f79e048..8df5fa487973 100644 --- a/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h +++ b/modules/juce_gui_extra/misc/juce_WebBrowserComponent.h @@ -482,8 +482,10 @@ class JUCE_API WebBrowserComponent : public Component class EvaluationResult { public: + /** A simple error type class. */ struct Error { + /** Error type. */ enum class Type { /** Error occurring for a reason unknown to us. */ diff --git a/modules/juce_gui_extra/misc/juce_WebControlParameterIndexReceiver.h b/modules/juce_gui_extra/misc/juce_WebControlParameterIndexReceiver.h index 7e953760c4a2..06dddddd5b6c 100644 --- a/modules/juce_gui_extra/misc/juce_WebControlParameterIndexReceiver.h +++ b/modules/juce_gui_extra/misc/juce_WebControlParameterIndexReceiver.h @@ -46,6 +46,8 @@ namespace juce In your frontend code you can use the ControlParameterIndexUpdater class, that emits controlParameterIndexChanged events based on the mouse movement, and control parameter index annotations attached to DOM elements. + + @tags{GUI} */ class JUCE_API WebControlParameterIndexReceiver : public OptionsBuilder { diff --git a/modules/juce_gui_extra/misc/juce_WebControlRelays.h b/modules/juce_gui_extra/misc/juce_WebControlRelays.h index ef53c7d2ecc7..77ca8210da3e 100644 --- a/modules/juce_gui_extra/misc/juce_WebControlRelays.h +++ b/modules/juce_gui_extra/misc/juce_WebControlRelays.h @@ -59,6 +59,8 @@ namespace juce @endcode @see WebSliderParameterAttachment + + @tags{GUI} */ class JUCE_API WebSliderRelay : public OptionsBuilder { @@ -129,6 +131,8 @@ class JUCE_API WebSliderRelay : public OptionsBuilder { @@ -197,6 +201,8 @@ class JUCE_API WebToggleButtonRelay : public OptionsBuilder {