From ad38182530f06affb63d60ce7df77198eca9934e Mon Sep 17 00:00:00 2001 From: ed Date: Fri, 5 Feb 2021 12:34:12 +0000 Subject: [PATCH] Added checks for DOXYGEN #define when excluding modal methods in headers --- modules/juce_gui_basics/components/juce_Component.h | 2 +- .../juce_gui_basics/components/juce_ModalComponentManager.h | 2 +- modules/juce_gui_basics/filebrowser/juce_FileChooser.h | 2 +- .../juce_gui_basics/filebrowser/juce_FileChooserDialogBox.h | 2 +- modules/juce_gui_basics/menus/juce_PopupMenu.h | 2 +- modules/juce_gui_basics/windows/juce_AlertWindow.h | 4 ++-- modules/juce_gui_basics/windows/juce_DialogWindow.cpp | 2 +- modules/juce_gui_basics/windows/juce_NativeMessageBox.h | 2 +- .../juce_gui_basics/windows/juce_ThreadWithProgressWindow.h | 2 +- modules/juce_gui_extra/documents/juce_FileBasedDocument.h | 2 +- 10 files changed, 11 insertions(+), 11 deletions(-) diff --git a/modules/juce_gui_basics/components/juce_Component.h b/modules/juce_gui_basics/components/juce_Component.h index 5dbeb7a00c..6b2b0072b7 100644 --- a/modules/juce_gui_basics/components/juce_Component.h +++ b/modules/juce_gui_basics/components/juce_Component.h @@ -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 diff --git a/modules/juce_gui_basics/components/juce_ModalComponentManager.h b/modules/juce_gui_basics/components/juce_ModalComponentManager.h index 996c5754df..029ac225ad 100644 --- a/modules/juce_gui_basics/components/juce_ModalComponentManager.h +++ b/modules/juce_gui_basics/components/juce_ModalComponentManager.h @@ -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. */ diff --git a/modules/juce_gui_basics/filebrowser/juce_FileChooser.h b/modules/juce_gui_basics/filebrowser/juce_FileChooser.h index 6e0162a77d..e1a50ee98d 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FileChooser.h +++ b/modules/juce_gui_basics/filebrowser/juce_FileChooser.h @@ -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 diff --git a/modules/juce_gui_basics/filebrowser/juce_FileChooserDialogBox.h b/modules/juce_gui_basics/filebrowser/juce_FileChooserDialogBox.h index 5fbf6c88f6..160978e4ca 100644 --- a/modules/juce_gui_basics/filebrowser/juce_FileChooserDialogBox.h +++ b/modules/juce_gui_basics/filebrowser/juce_FileChooserDialogBox.h @@ -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 diff --git a/modules/juce_gui_basics/menus/juce_PopupMenu.h b/modules/juce_gui_basics/menus/juce_PopupMenu.h index 04bafe8714..495c62c3c2 100644 --- a/modules/juce_gui_basics/menus/juce_PopupMenu.h +++ b/modules/juce_gui_basics/menus/juce_PopupMenu.h @@ -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 diff --git a/modules/juce_gui_basics/windows/juce_AlertWindow.h b/modules/juce_gui_basics/windows/juce_AlertWindow.h index 1b234c439b..d73eb07b45 100644 --- a/modules/juce_gui_basics/windows/juce_AlertWindow.h +++ b/modules/juce_gui_basics/windows/juce_AlertWindow.h @@ -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); diff --git a/modules/juce_gui_basics/windows/juce_DialogWindow.cpp b/modules/juce_gui_basics/windows/juce_DialogWindow.cpp index ea2675d59d..cc52070199 100644 --- a/modules/juce_gui_basics/windows/juce_DialogWindow.cpp +++ b/modules/juce_gui_basics/windows/juce_DialogWindow.cpp @@ -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(); diff --git a/modules/juce_gui_basics/windows/juce_NativeMessageBox.h b/modules/juce_gui_basics/windows/juce_NativeMessageBox.h index 70b097a59f..5a5e86d755 100644 --- a/modules/juce_gui_basics/windows/juce_NativeMessageBox.h +++ b/modules/juce_gui_basics/windows/juce_NativeMessageBox.h @@ -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, diff --git a/modules/juce_gui_basics/windows/juce_ThreadWithProgressWindow.h b/modules/juce_gui_basics/windows/juce_ThreadWithProgressWindow.h index 91664e0c21..8c892d17d2 100644 --- a/modules/juce_gui_basics/windows/juce_ThreadWithProgressWindow.h +++ b/modules/juce_gui_basics/windows/juce_ThreadWithProgressWindow.h @@ -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 diff --git a/modules/juce_gui_extra/documents/juce_FileBasedDocument.h b/modules/juce_gui_extra/documents/juce_FileBasedDocument.h index 8e929c7601..6515131a01 100644 --- a/modules/juce_gui_extra/documents/juce_FileBasedDocument.h +++ b/modules/juce_gui_extra/documents/juce_FileBasedDocument.h @@ -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