Browse Source

Documentation fixes

tags/2021-05-28
Tom Poole 8 years ago
parent
commit
89d9ad0856
1 changed files with 4 additions and 4 deletions
  1. +4
    -4
      modules/juce_gui_extra/misc/juce_PushNotifications.h

+ 4
- 4
modules/juce_gui_extra/misc/juce_PushNotifications.h View File

@@ -179,7 +179,7 @@ public:
number of actions to be presented, so always present most important actions first. number of actions to be presented, so always present most important actions first.
Available from Android API 16 or above. */ Available from Android API 16 or above. */
/**< Used to represent a progress of some operation. */
/** Used to represent a progress of some operation. */
struct Progress struct Progress
{ {
int max = 0; /**< Max possible value of a progress. A typical usecase is to set max to 100 and increment int max = 0; /**< Max possible value of a progress. A typical usecase is to set max to 100 and increment
@@ -253,7 +253,7 @@ public:
Colour ledColour; /**< Optional: Sets the led colour. The hardware will do its best to approximate the colour. Colour ledColour; /**< Optional: Sets the led colour. The hardware will do its best to approximate the colour.
The default colour will be used if ledColour is not set. */ The default colour will be used if ledColour is not set. */
/**< Allows to control the time the device's led is on and off. */
/** Allows to control the time the device's led is on and off. */
struct LedBlinkPattern struct LedBlinkPattern
{ {
int msToBeOn = 0; /**< The led will be on for the given number of milliseconds, after which it will turn off. */ int msToBeOn = 0; /**< The led will be on for the given number of milliseconds, after which it will turn off. */
@@ -282,7 +282,7 @@ public:
bool alertOnlyOnce = false; /**< Optional: Set this flag if you would only like the sound, vibrate and ticker to be played if the notification bool alertOnlyOnce = false; /**< Optional: Set this flag if you would only like the sound, vibrate and ticker to be played if the notification
is not already showing. */ is not already showing. */
/**< Controls timestamp visibility and format. */
/** Controls timestamp visibility and format. */
enum TimestampVisibility enum TimestampVisibility
{ {
off, /**< Do not show timestamp. */ off, /**< Do not show timestamp. */
@@ -293,7 +293,7 @@ public:
TimestampVisibility timestampVisibility = normal; /**< Optional. */ TimestampVisibility timestampVisibility = normal; /**< Optional. */
/**< Controls badge icon type to use if a notification is shown as a badge. Available from Android API 26 or above. */
/** Controls badge icon type to use if a notification is shown as a badge. Available from Android API 26 or above. */
enum BadgeIconType enum BadgeIconType
{ {
none, none,


Loading…
Cancel
Save