From fdf41bcce3eaf71009286ab4ec1f278bae3eafe8 Mon Sep 17 00:00:00 2001 From: Klaus Basan Date: Sun, 13 Mar 2016 19:01:47 +0000 Subject: [PATCH] Doxygen --- src/blackcore/contextsimulatorimpl.cpp | 4 +-- src/blackcore/cookiemanager.h | 4 +-- src/blackcore/webreaderflags.h | 24 ++++++++-------- src/blackgui/components/dbmappingcomponent.h | 6 ++-- src/blackgui/models/aircraftmodellistmodel.h | 10 +++---- src/blackgui/views/viewbase.h | 30 ++++++++++---------- 6 files changed, 38 insertions(+), 40 deletions(-) diff --git a/src/blackcore/contextsimulatorimpl.cpp b/src/blackcore/contextsimulatorimpl.cpp index 9e61d3483..e424b6458 100644 --- a/src/blackcore/contextsimulatorimpl.cpp +++ b/src/blackcore/contextsimulatorimpl.cpp @@ -466,9 +466,7 @@ namespace BlackCore void CContextSimulator::ps_addRemoteAircraft(const CSimulatedAircraft &remoteAircraft) { - // todo: - // This was previously an assert and it should be one again in the future. - // This slot should not even be called when no simulator is available. + //! \todo This was previously an assert and it should be one again in the future. This slot should not even be called when no simulator is available. if (m_simulatorPlugin.first.isUnspecified()) { // Do something if no simulator is running diff --git a/src/blackcore/cookiemanager.h b/src/blackcore/cookiemanager.h index be3cd1c27..bd1694749 100644 --- a/src/blackcore/cookiemanager.h +++ b/src/blackcore/cookiemanager.h @@ -33,11 +33,11 @@ namespace BlackCore friend class CApplication; public: - //! cookiesForUrl::setCookiesFromUrl + //! \copydoc QNetworkCookieJar::setCookiesFromUrl //! \threadsafe virtual bool setCookiesFromUrl(const QList &cookies, const QUrl &url) override; - //! QNetworkCookieJar::cookiesForUrl + //! \copydoc QNetworkCookieJar::cookiesForUrl //! \threadsafe virtual QList cookiesForUrl(const QUrl &url) const override; diff --git a/src/blackcore/webreaderflags.h b/src/blackcore/webreaderflags.h index efb220ebc..c04289e73 100644 --- a/src/blackcore/webreaderflags.h +++ b/src/blackcore/webreaderflags.h @@ -28,15 +28,15 @@ namespace BlackCore //! Which readers to init enum WebReaderFlag { - None = 0, ///< no reader at all - VatsimBookingReader = 1 << 0, ///< reader for VATSIM booking data - VatsimDataReader = 1 << 1, ///< reader for VATSIM data - VatsimMetarReader = 1 << 2, ///< reader for VATSIM metar data - IcaoDataReader = 1 << 3, ///< reader for ICAO data - ModelReader = 1 << 4, ///< reader for model data such as liveries, models, .. - AllVatsimReaders = VatsimBookingReader | VatsimDataReader | VatsimMetarReader, ///< all readers - AllSwiftDbReaders = IcaoDataReader | ModelReader, ///< all swift data - AllReaders = AllSwiftDbReaders | AllVatsimReaders ///< everything + None = 0, //!< no reader at all + VatsimBookingReader = 1 << 0, //!< reader for VATSIM booking data + VatsimDataReader = 1 << 1, //!< reader for VATSIM data + VatsimMetarReader = 1 << 2, //!< reader for VATSIM metar data + IcaoDataReader = 1 << 3, //!< reader for ICAO data + ModelReader = 1 << 4, //!< reader for model data such as liveries, models, etc + AllVatsimReaders = VatsimBookingReader | VatsimDataReader | VatsimMetarReader, //!< all readers + AllSwiftDbReaders = IcaoDataReader | ModelReader, //!< all swift data + AllReaders = AllSwiftDbReaders | AllVatsimReaders //!< everything }; Q_DECLARE_FLAGS(WebReader, WebReaderFlag) @@ -44,9 +44,9 @@ namespace BlackCore enum DbReaderHintFlag { NoHint = 0, - FromDb = 1 << 1, ///< directly from DB - FromJsonFile = 1 << 2, ///< from the JSON files - FromCache = 1 << 3, ///< try cache first + FromDb = 1 << 1, //!< directly from DB + FromJsonFile = 1 << 2, //!< from the JSON files + FromCache = 1 << 3, //!< try cache first }; Q_DECLARE_FLAGS(DbReaderHint, DbReaderHintFlag) diff --git a/src/blackgui/components/dbmappingcomponent.h b/src/blackgui/components/dbmappingcomponent.h index cebc28cec..ed4848588 100644 --- a/src/blackgui/components/dbmappingcomponent.h +++ b/src/blackgui/components/dbmappingcomponent.h @@ -271,9 +271,9 @@ namespace BlackGui }; //! Menu for tools: - //! 1) removing DB models from current view and - //! 2) for auto stashing - //! 3) toggle auto filtering + //! -# removing DB models from current view and + //! -# for auto stashing + //! -# toggle auto filtering //! \note This is a specific menu for that very component class CModelStashTools : public BlackGui::IMenuDelegate { diff --git a/src/blackgui/models/aircraftmodellistmodel.h b/src/blackgui/models/aircraftmodellistmodel.h index d1f2ccab4..c644d6886 100644 --- a/src/blackgui/models/aircraftmodellistmodel.h +++ b/src/blackgui/models/aircraftmodellistmodel.h @@ -33,11 +33,11 @@ namespace BlackGui enum AircraftModelMode { NotSet, - OwnSimulatorModel, ///< models existing for my simulator - OwnSimulatorModelMapping, ///< models of my simulator, but in mapping mode - Database, ///< Database entry - VPilotRuleModel, ///< vPilot rule turned into model - StashModel ///< stashed models + OwnSimulatorModel, //!< models existing for my simulator + OwnSimulatorModelMapping, //!< models of my simulator, but in mapping mode + Database, //!< Database entry + VPilotRuleModel, //!< vPilot rule turned into model + StashModel //!< stashed models }; //! Constructor diff --git a/src/blackgui/views/viewbase.h b/src/blackgui/views/viewbase.h index 3f873ffd9..1cdd293b1 100644 --- a/src/blackgui/views/viewbase.h +++ b/src/blackgui/views/viewbase.h @@ -68,17 +68,17 @@ namespace BlackGui //! Menu flags enum MenuFlag { - MenuNone = 0, ///< no menu - MenuClear = 1 << 0, ///< allow clearing the view via menu - MenuRemoveSelectedRows = 1 << 1, ///< allow to remove selected rows - MenuRefresh = 1 << 2, ///< allow refreshing the view via menu - MenuBackend = 1 << 3, ///< allow to request data from backend - MenuDisplayAutomatically = 1 << 4, ///< allow to switch display automatically - MenuDisplayAutomaticallyAndRefresh = MenuDisplayAutomatically | MenuRefresh, ///< should come together - MenuFilter = 1 << 5, ///< filter can be opened - MenuSave = 1 << 6, ///< save as JSON - MenuLoad = 1 << 7, ///< load from JSON - MenuToggleSelectionMode = 1 << 8, ///< allow to toggle selection mode + MenuNone = 0, //!< no menu + MenuClear = 1 << 0, //!< allow clearing the view via menu + MenuRemoveSelectedRows = 1 << 1, //!< allow to remove selected rows + MenuRefresh = 1 << 2, //!< allow refreshing the view via menu + MenuBackend = 1 << 3, //!< allow to request data from backend + MenuDisplayAutomatically = 1 << 4, //!< allow to switch display automatically + MenuDisplayAutomaticallyAndRefresh = MenuDisplayAutomatically | MenuRefresh, //!< should come together + MenuFilter = 1 << 5, //!< filter can be opened + MenuSave = 1 << 6, //!< save as JSON + MenuLoad = 1 << 7, //!< load from JSON + MenuToggleSelectionMode = 1 << 8, //!< allow to toggle selection mode MenuStandard = MenuClear | MenuRemoveSelectedRows | MenuRefresh | MenuBackend | MenuDisplayAutomatically | MenuFilter | MenuSave | MenuLoad | MenuToggleSelectionMode, MenuLoadAndSave = MenuLoad | MenuSave, @@ -87,11 +87,11 @@ namespace BlackGui MenuDefaultDbViews = MenuToggleSelectionMode | MenuBackend, // special menus, should be in derived classes, but enums cannot be inherited // maybe shifted in the future to elsewhere - MenuHighlightDbData = 1 << 9, ///< highlight DB data - MenuHighlightStashed = 1 << 10, ///< highlight stashed models - MenuCanStashModels = 1 << 11, ///< stash models + MenuHighlightDbData = 1 << 9, //!< highlight DB data + MenuHighlightStashed = 1 << 10, //!< highlight stashed models + MenuCanStashModels = 1 << 11, //!< stash models MenuStashing = MenuHighlightStashed | MenuCanStashModels, - MenuHighlightInvalid = 1 << 12 ///< highlight invalid models + MenuHighlightInvalid = 1 << 12 //!< highlight invalid models }; Q_DECLARE_FLAGS(Menu, MenuFlag)