Browse Source

Fixed some documentation.

tags/2021-05-28
jules 10 years ago
parent
commit
f02562f2c4
3 changed files with 13 additions and 14 deletions
  1. +2
    -2
      modules/juce_audio_utils/gui/juce_AudioAppComponent.h
  2. +8
    -9
      modules/juce_graphics/geometry/juce_Path.h
  3. +3
    -3
      modules/juce_gui_basics/components/juce_ModalComponentManager.h

+ 2
- 2
modules/juce_audio_utils/gui/juce_AudioAppComponent.h View File

@@ -31,8 +31,8 @@
A base class for writing audio apps that stream from the audio i/o devices.
A subclass can inherit from this and implement just a few methods such as
renderAudio(). The base class provides a basic AudioDeviceManager object
and runs audio through the
getNextAudioBlock(). The base class provides a basic AudioDeviceManager object
and runs audio through the default output device.
*/
class AudioAppComponent : public Component,
public AudioSource


+ 8
- 9
modules/juce_graphics/geometry/juce_Path.h View File

@@ -499,21 +499,20 @@ public:
/** Adds a "pie-chart" shape to the path.
The shape is added as a new sub-path. (Any currently open paths will be
left open).
The shape is added as a new sub-path. (Any currently open paths will be left open).
Note that when specifying the start and end angles, the curve will be drawn either clockwise
or anti-clockwise according to whether the end angle is greater than the start. This means
that sometimes you may need to use values greater than 2*Pi for the end angle.
@param area the outer rectangle in which the elliptical outline fits
@param fromRadians the angle (clockwise) in radians at which to start the arc segment (where 0 is the
top-centre of the ellipse)
@param toRadians the angle (clockwise) in radians at which to end the arc segment (where 0 is the
top-centre of the ellipse)
@param segmentBounds the outer rectangle in which the elliptical outline fits
@param fromRadians the angle (clockwise) in radians at which to start the arc segment (where 0 is the
top-centre of the ellipse)
@param toRadians the angle (clockwise) in radians at which to end the arc segment (where 0 is the
top-centre of the ellipse)
@param innerCircleProportionalSize if this is > 0, then the pie will be drawn as a curved band around a hollow
ellipse at its centre, where this value indicates the inner ellipse's size with
respect to the outer one.
ellipse at its centre, where this value indicates the inner ellipse's size with
respect to the outer one.
@see addArc
*/
void addPieSegment (Rectangle<float> segmentBounds,


+ 3
- 3
modules/juce_gui_basics/components/juce_ModalComponentManager.h View File

@@ -72,6 +72,9 @@ public:
virtual void modalStateFinished (int returnValue) = 0;
};
//==============================================================================
juce_DeclareSingleton_SingleThreaded_Minimal (ModalComponentManager)
//==============================================================================
/** Returns the number of components currently being shown modally.
@see getModalComponent
@@ -119,9 +122,6 @@ public:
int runEventLoopForCurrentComponent();
#endif
//==============================================================================
juce_DeclareSingleton_SingleThreaded_Minimal (ModalComponentManager)
protected:
/** Creates a ModalComponentManager.
You shouldn't ever call the constructor - it's a singleton, so use ModalComponentManager::getInstance()


Loading…
Cancel
Save