mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-10 23:44:24 +00:00
Fix some Doxygen docstrings
This commit is contained in:
parent
4808fdce30
commit
05b036272a
10 changed files with 41 additions and 1 deletions
|
|
@ -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
|
class SpringEasingOptions
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
|
|
||||||
|
|
@ -32,6 +32,10 @@
|
||||||
==============================================================================
|
==============================================================================
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
/** A base class for building Options.
|
||||||
|
|
||||||
|
@tags{Core}
|
||||||
|
*/
|
||||||
template <typename OptionsType>
|
template <typename OptionsType>
|
||||||
class OptionsBuilder
|
class OptionsBuilder
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -32,6 +32,8 @@
|
||||||
==============================================================================
|
==============================================================================
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
#ifndef DOXYGEN
|
||||||
|
|
||||||
namespace juce
|
namespace juce
|
||||||
{
|
{
|
||||||
|
|
||||||
|
|
@ -47,3 +49,5 @@ struct FunctionPointerDestructor
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace juce
|
} // namespace juce
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
|
||||||
|
|
@ -32,6 +32,8 @@
|
||||||
==============================================================================
|
==============================================================================
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
#ifndef DOXYGEN
|
||||||
|
|
||||||
namespace juce
|
namespace juce
|
||||||
{
|
{
|
||||||
|
|
||||||
|
|
@ -82,3 +84,5 @@ private:
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace juce
|
} // namespace juce
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
|
||||||
|
|
@ -37,6 +37,8 @@ namespace juce
|
||||||
|
|
||||||
/** A single path-based layer of a colour glyph. Contains the glyph shape and the colour in which
|
/** A single path-based layer of a colour glyph. Contains the glyph shape and the colour in which
|
||||||
the shape should be painted.
|
the shape should be painted.
|
||||||
|
|
||||||
|
@tags{Graphics}
|
||||||
*/
|
*/
|
||||||
struct ColourLayer
|
struct ColourLayer
|
||||||
{
|
{
|
||||||
|
|
@ -45,6 +47,8 @@ struct ColourLayer
|
||||||
};
|
};
|
||||||
|
|
||||||
/** A bitmap representing (part of) a glyph, most commonly used to represent colour emoji glyphs.
|
/** A bitmap representing (part of) a glyph, most commonly used to represent colour emoji glyphs.
|
||||||
|
|
||||||
|
@tags{Graphics}
|
||||||
*/
|
*/
|
||||||
struct ImageLayer
|
struct ImageLayer
|
||||||
{
|
{
|
||||||
|
|
@ -53,6 +57,8 @@ struct ImageLayer
|
||||||
};
|
};
|
||||||
|
|
||||||
/** A single layer that makes up part of a glyph image.
|
/** A single layer that makes up part of a glyph image.
|
||||||
|
|
||||||
|
@tags{Graphics}
|
||||||
*/
|
*/
|
||||||
struct GlyphLayer
|
struct GlyphLayer
|
||||||
{
|
{
|
||||||
|
|
@ -85,6 +91,8 @@ enum class TypefaceMetricsKind
|
||||||
};
|
};
|
||||||
|
|
||||||
/** Font metrics using JUCE conventions.
|
/** Font metrics using JUCE conventions.
|
||||||
|
|
||||||
|
@tags{Graphics}
|
||||||
*/
|
*/
|
||||||
struct TypefaceMetrics
|
struct TypefaceMetrics
|
||||||
{
|
{
|
||||||
|
|
@ -280,6 +288,7 @@ public:
|
||||||
const auto isMonochrome = typeface->getColourGlyphFormats() == 0;
|
const auto isMonochrome = typeface->getColourGlyphFormats() == 0;
|
||||||
const auto isSvg = (typeface->getColourGlyphFormats() & Typeface::colourGlyphFormatSvg) != 0;
|
const auto isSvg = (typeface->getColourGlyphFormats() & Typeface::colourGlyphFormatSvg) != 0;
|
||||||
const auto isSimpleColour = (typeface->getColourGlyphFormats() & (Typeface::colourGlyphFormatBitmap | Typeface::colourGlyphFormatCOLRv0)) != 0;
|
const auto isSimpleColour = (typeface->getColourGlyphFormats() & (Typeface::colourGlyphFormatBitmap | Typeface::colourGlyphFormatCOLRv0)) != 0;
|
||||||
|
@endcode
|
||||||
*/
|
*/
|
||||||
int getColourGlyphFormats() const;
|
int getColourGlyphFormats() const;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -32,6 +32,8 @@
|
||||||
==============================================================================
|
==============================================================================
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
#ifndef DOXYGEN
|
||||||
|
|
||||||
namespace juce
|
namespace juce
|
||||||
{
|
{
|
||||||
|
|
||||||
|
|
@ -68,3 +70,5 @@ private:
|
||||||
JUCE_IMPLEMENT_SINGLETON (TypefaceFileCache)
|
JUCE_IMPLEMENT_SINGLETON (TypefaceFileCache)
|
||||||
|
|
||||||
} // namespace juce
|
} // namespace juce
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
|
||||||
|
|
@ -42,6 +42,8 @@ namespace juce
|
||||||
|
|
||||||
@see Slider::addListener, Slider::removeListener, WebSliderRelay::addListener,
|
@see Slider::addListener, Slider::removeListener, WebSliderRelay::addListener,
|
||||||
WebSliderRelay::removeListener
|
WebSliderRelay::removeListener
|
||||||
|
|
||||||
|
@tags{GUI}
|
||||||
*/
|
*/
|
||||||
template <typename Emitter>
|
template <typename Emitter>
|
||||||
class JUCE_API SliderListener
|
class JUCE_API SliderListener
|
||||||
|
|
|
||||||
|
|
@ -482,8 +482,10 @@ public:
|
||||||
class EvaluationResult
|
class EvaluationResult
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
|
/** A simple error type class. */
|
||||||
struct Error
|
struct Error
|
||||||
{
|
{
|
||||||
|
/** Error type. */
|
||||||
enum class Type
|
enum class Type
|
||||||
{
|
{
|
||||||
/** Error occurring for a reason unknown to us. */
|
/** Error occurring for a reason unknown to us. */
|
||||||
|
|
|
||||||
|
|
@ -46,6 +46,8 @@ namespace juce
|
||||||
In your frontend code you can use the ControlParameterIndexUpdater class, that emits
|
In your frontend code you can use the ControlParameterIndexUpdater class, that emits
|
||||||
controlParameterIndexChanged events based on the mouse movement, and control parameter index
|
controlParameterIndexChanged events based on the mouse movement, and control parameter index
|
||||||
annotations attached to DOM elements.
|
annotations attached to DOM elements.
|
||||||
|
|
||||||
|
@tags{GUI}
|
||||||
*/
|
*/
|
||||||
class JUCE_API WebControlParameterIndexReceiver : public OptionsBuilder<WebBrowserComponent::Options>
|
class JUCE_API WebControlParameterIndexReceiver : public OptionsBuilder<WebBrowserComponent::Options>
|
||||||
{
|
{
|
||||||
|
|
|
||||||
|
|
@ -59,6 +59,8 @@ namespace juce
|
||||||
@endcode
|
@endcode
|
||||||
|
|
||||||
@see WebSliderParameterAttachment
|
@see WebSliderParameterAttachment
|
||||||
|
|
||||||
|
@tags{GUI}
|
||||||
*/
|
*/
|
||||||
class JUCE_API WebSliderRelay : public OptionsBuilder<WebBrowserComponent::Options>
|
class JUCE_API WebSliderRelay : public OptionsBuilder<WebBrowserComponent::Options>
|
||||||
{
|
{
|
||||||
|
|
@ -129,6 +131,8 @@ private:
|
||||||
@endcode
|
@endcode
|
||||||
|
|
||||||
@see WebToggleButtonParameterAttachment
|
@see WebToggleButtonParameterAttachment
|
||||||
|
|
||||||
|
@tags{GUI}
|
||||||
*/
|
*/
|
||||||
class JUCE_API WebToggleButtonRelay : public OptionsBuilder<WebBrowserComponent::Options>
|
class JUCE_API WebToggleButtonRelay : public OptionsBuilder<WebBrowserComponent::Options>
|
||||||
{
|
{
|
||||||
|
|
@ -197,6 +201,8 @@ private:
|
||||||
@endcode
|
@endcode
|
||||||
|
|
||||||
@see WebComboBoxParameterAttachment
|
@see WebComboBoxParameterAttachment
|
||||||
|
|
||||||
|
@tags{GUI}
|
||||||
*/
|
*/
|
||||||
class JUCE_API WebComboBoxRelay : public OptionsBuilder<WebBrowserComponent::Options>
|
class JUCE_API WebComboBoxRelay : public OptionsBuilder<WebBrowserComponent::Options>
|
||||||
{
|
{
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue