Skip to content

Commit

Permalink
Reword some MixxxMainWindow documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xeruf committed Jun 19, 2020
1 parent d97c0c9 commit 87d246b
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 20 deletions.
19 changes: 10 additions & 9 deletions src/mixxx.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -483,16 +483,17 @@ void MixxxMainWindow::initialize(QApplication* pApp, const CmdlineArgs& args) {

// Load skin to a QWidget that we set as the central widget. Assignment
// intentional in next line.
if (!(m_pRootWidget = m_pSkinLoader->loadConfiguredSkin(this, m_pKeyboard,
m_pPlayerManager,
m_pControllerManager,
m_pLibrary,
m_pVCManager,
m_pEffectsManager,
m_pRecordingManager))) {
m_pRootWidget = m_pSkinLoader->loadConfiguredSkin(this,
m_pKeyboard,
m_pPlayerManager,
m_pControllerManager,
m_pLibrary,
m_pVCManager,
m_pEffectsManager,
m_pRecordingManager);
if (m_pRootWidget == nullptr) {
reportCriticalErrorAndQuit(
"default skin cannot be loaded see <b>mixxx</b> trace for more information.");

"default skin cannot be loaded - see <b>mixxx</b> trace for more information");
m_pRootWidget = oldWidget;
//TODO (XXX) add dialog to warn user and launch skin choice page
}
Expand Down
20 changes: 9 additions & 11 deletions src/mixxx.h
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,8 @@ class VinylControlManager;
class VisualsManager;
class WMainMenuBar;

typedef QSharedPointer<SettingsManager> SettingsManagerPointer;

/// This Class is the base class for Mixxx. It sets up the main
/// window and providing a menubar.
/// This Class is the base class for Mixxx.
/// It sets up the main window providing a menubar.
/// For the main view, an instance of class MixxxView is
/// created which creates your view.
class MixxxMainWindow : public QMainWindow {
Expand Down Expand Up @@ -66,28 +64,28 @@ class MixxxMainWindow : public QMainWindow {
void slotFileLoadSongPlayer(int deck);
/// toggle keyboard on-off
void slotOptionsKeyboard(bool toggle);
/// Preference dialog
/// show the preferences dialog
void slotOptionsPreferences();
/// shows an about dlalogg
/// show the about dialog
void slotHelpAbout();
/// toggle full screen mode
void slotViewFullScreen(bool toggle);
/// Open the developer tools dialog.
/// open the developer tools dialog.
void slotDeveloperTools(bool enable);
void slotDeveloperToolsClosed();

void slotUpdateWindowTitle(TrackPointer pTrack);
void slotChangedPlayingDeck(int deck);

/// Warn the user when inputs are not configured.
/// warn the user when inputs are not configured.
void slotNoMicrophoneInputConfigured();
void slotNoAuxiliaryInputConfigured();
void slotNoDeckPassthroughInputConfigured();
void slotNoVinylControlInputConfigured();

signals:
void skinLoaded();
/// used to uncheck the menu when the dialog of develeoper tools is closed
/// used to uncheck the menu when the dialog of developer tools is closed
void developerToolsDlgClosed(int r);
void closeDeveloperToolsDlgChecked(int r);
void fullScreenChanged(bool fullscreen);
Expand Down Expand Up @@ -127,7 +125,7 @@ class MixxxMainWindow : public QMainWindow {
/// The effects processing system
EffectsManager* m_pEffectsManager;

/// The mixing engine.
/// The mixing engine
EngineMaster* m_pEngine;

SkinLoader* m_pSkinLoader; // TODO(rryan): doesn't need to be a member variable
Expand Down Expand Up @@ -164,7 +162,7 @@ class MixxxMainWindow : public QMainWindow {
ConfigObject<ConfigValueKbd>* m_pKbdConfigEmpty;

mixxx::TooltipsPreference m_toolTipsCfg;
/// Timer that tracks how long Mixxx has been running.
/// tracks how long Mixxx has been running
Timer m_runtime_timer;

const CmdlineArgs& m_cmdLineArgs;
Expand Down

0 comments on commit 87d246b

Please sign in to comment.