1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00

Add documentation tags

This commit is contained in:
ed 2018-03-15 10:47:05 +00:00
parent e982c70438
commit cdbc28c18b
534 changed files with 1531 additions and 72 deletions

View file

@ -33,6 +33,8 @@ namespace juce
This class is used to store sets of X and Y marker points in components.
@see Component::getMarkers().
@tags{GUI}
*/
class JUCE_API MarkerList
{

View file

@ -67,6 +67,8 @@ namespace juce
be thrown!
@see RelativePoint, RelativeRectangle
@tags{GUI}
*/
class JUCE_API RelativeCoordinate
{
@ -158,6 +160,7 @@ public:
static const String height; /**< "height" */
};
/** @internal */
struct StandardStrings
{
enum Type

View file

@ -30,6 +30,8 @@ namespace juce
//==============================================================================
/**
Base class for Component::Positioners that are based upon relative coordinates.
@tags{GUI}
*/
class JUCE_API RelativeCoordinatePositionerBase : public Component::Positioner,
public ComponentListener,

View file

@ -32,6 +32,8 @@ namespace juce
A parallelogram defined by three RelativePoint positions.
@see RelativePoint, RelativeCoordinate
@tags{GUI}
*/
class JUCE_API RelativeParallelogram
{

View file

@ -32,6 +32,8 @@ namespace juce
An X-Y position stored as a pair of RelativeCoordinate values.
@see RelativeCoordinate, RelativeRectangle
@tags{GUI}
*/
class JUCE_API RelativePoint
{

View file

@ -35,6 +35,8 @@ namespace juce
unlike a Path, its points can be dynamic instead of just fixed.
@see RelativePoint, RelativeCoordinate
@tags{GUI}
*/
class JUCE_API RelativePointPath
{
@ -92,6 +94,7 @@ public:
};
//==============================================================================
/** Class for the start sub path element */
class JUCE_API StartSubPath : public ElementBase
{
public:
@ -107,6 +110,7 @@ public:
};
//==============================================================================
/** Class for the close sub path element */
class JUCE_API CloseSubPath : public ElementBase
{
public:
@ -120,6 +124,7 @@ public:
};
//==============================================================================
/** Class for the line to element */
class JUCE_API LineTo : public ElementBase
{
public:
@ -135,6 +140,7 @@ public:
};
//==============================================================================
/** Class for the quadratic to element */
class JUCE_API QuadraticTo : public ElementBase
{
public:
@ -151,6 +157,7 @@ public:
};
//==============================================================================
/** Class for the cubic to element */
class JUCE_API CubicTo : public ElementBase
{
public:

View file

@ -34,6 +34,8 @@ namespace juce
The rectangle's top, left, bottom and right edge positions are each stored as a RelativeCoordinate.
@see RelativeCoordinate, RelativePoint
@tags{GUI}
*/
class JUCE_API RelativeRectangle
{