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

Added checks for DOXYGEN #define when excluding modal methods in headers

Browse source
This commit is contained in:
ed 2021-02-05 12:34:12 +00:00
parent 04c28eaa3b
commit ad38182530
10 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

2
modules/juce_gui_basics/components/juce_Component.h
View file

@ -1942,7 +1942,7 @@ public:
virtual void handleCommandMessage (int commandId);
//==============================================================================
#if JUCE_MODAL_LOOPS_PERMITTED
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
/** Runs a component modally, waiting until the loop terminates.
This method first makes the component visible, brings it to the front and

2
modules/juce_gui_basics/components/juce_ModalComponentManager.h
View file

@ -119,7 +119,7 @@ public:
*/
bool cancelAllModalComponents();
#if JUCE_MODAL_LOOPS_PERMITTED
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
/** Runs the event loop until the currently topmost modal component is dismissed, and
returns the exit code for that component.
*/

2
modules/juce_gui_basics/filebrowser/juce_FileChooser.h
View file

@ -125,7 +125,7 @@ public:
~FileChooser();
//==============================================================================
#if JUCE_MODAL_LOOPS_PERMITTED
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
/** Shows a dialog box to choose a file to open.
This will display the dialog box modally, using an "open file" mode, so that

2
modules/juce_gui_basics/filebrowser/juce_FileChooserDialogBox.h
View file

@ -99,7 +99,7 @@ public:
~FileChooserDialogBox() override;
//==============================================================================
#if JUCE_MODAL_LOOPS_PERMITTED
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
/** Displays and runs the dialog box modally.
This will show the box with the specified size, returning true if the user

2
modules/juce_gui_basics/menus/juce_PopupMenu.h
View file

@ -495,7 +495,7 @@ public:
};
//==============================================================================
#if JUCE_MODAL_LOOPS_PERMITTED
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
/** Displays the menu and waits for the user to pick something.
This will display the menu modally, and return the ID of the item that the

4
modules/juce_gui_basics/windows/juce_AlertWindow.h
View file

@ -228,7 +228,7 @@ public:
//==============================================================================
// easy-to-use message box functions:
#if JUCE_MODAL_LOOPS_PERMITTED
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
/** Shows a dialog box that just has a message and a single button to get rid of it.
The box is shown modally, and the method will block until the user has clicked the
@ -394,7 +394,7 @@ public:
it'll show a box with just an ok button
@returns true if the ok button was pressed, false if they pressed cancel.
*/
#if JUCE_MODAL_LOOPS_PERMITTED
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
static bool JUCE_CALLTYPE showNativeDialogBox (const String& title,
const String& bodyText,
bool isOkCancel);

2
modules/juce_gui_basics/windows/juce_DialogWindow.cpp
View file

@ -117,7 +117,7 @@ DialogWindow* DialogWindow::LaunchOptions::launchAsync()
return d;
}
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
#if JUCE_MODAL_LOOPS_PERMITTED
int DialogWindow::LaunchOptions::runModal()
{
return launchAsync()->runModalLoop();

2
modules/juce_gui_basics/windows/juce_NativeMessageBox.h
View file

@ -47,7 +47,7 @@ public:
alert window should be associated with. Depending on the look
and feel, this might be used for positioning of the alert window.
*/
#if JUCE_MODAL_LOOPS_PERMITTED
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
static void JUCE_CALLTYPE showMessageBox (AlertWindow::AlertIconType iconType,
const String& title,
const String& message,

2
modules/juce_gui_basics/windows/juce_ThreadWithProgressWindow.h
View file

@ -113,7 +113,7 @@ public:
~ThreadWithProgressWindow() override;
//==============================================================================
#if JUCE_MODAL_LOOPS_PERMITTED
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
/** Starts the thread and waits for it to finish.
This will start the thread, make the dialog box appear, and wait until either

2
modules/juce_gui_extra/documents/juce_FileBasedDocument.h
View file

@ -277,7 +277,7 @@ protected:
*/
virtual void setLastDocumentOpened (const File& file) = 0;
#if JUCE_MODAL_LOOPS_PERMITTED
#if JUCE_MODAL_LOOPS_PERMITTED || DOXYGEN
/** This is called by saveAsInteractive() to allow you to optionally customise the
filename that the user is presented with in the save dialog.
The defaultFile parameter is an initial suggestion based on what the class knows