Skip to content

Commit

Permalink
Some fixes in doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-w committed Feb 25, 2016
1 parent 0787d6c commit bb4eca1
Show file tree
Hide file tree
Showing 11 changed files with 34 additions and 36 deletions.
14 changes: 7 additions & 7 deletions Doxyfile.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ DISTRIBUTE_GROUP_DOC = NO
# \nosubgrouping command.
# The default value is: YES.

SUBGROUPING = YES
SUBGROUPING = NO

# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
Expand Down Expand Up @@ -431,29 +431,29 @@ EXTRACT_PRIVATE = NO
# scope will be included in the documentation.
# The default value is: NO.

EXTRACT_PACKAGE = NO
EXTRACT_PACKAGE = YES

# If the EXTRACT_STATIC tag is set to YES all static members of a file will be
# included in the documentation.
# The default value is: NO.

EXTRACT_STATIC = NO
EXTRACT_STATIC = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.

EXTRACT_LOCAL_CLASSES = NO
EXTRACT_LOCAL_CLASSES = YES

# This flag is only useful for Objective-C code. When set to YES local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO only methods in the interface are
# included.
# The default value is: NO.

EXTRACT_LOCAL_METHODS = NO
EXTRACT_LOCAL_METHODS = YES

# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
Expand All @@ -462,7 +462,7 @@ EXTRACT_LOCAL_METHODS = NO
# are hidden.
# The default value is: NO.

EXTRACT_ANON_NSPACES = NO
EXTRACT_ANON_NSPACES = YES

# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
Expand All @@ -485,7 +485,7 @@ HIDE_UNDOC_CLASSES = NO
# included in the documentation.
# The default value is: NO.

HIDE_FRIEND_COMPOUNDS = YES
HIDE_FRIEND_COMPOUNDS = NO

# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO these
Expand Down
2 changes: 1 addition & 1 deletion doc/mainpage.doxygen
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ is targetted at developers of scripts, plugins and the core program.

The code of Stellarium is split into several main blocks:
<ul>
<li>the main loop and main widget classes @em StelMainWindow and @em StelMainGraphicsView. Those classes have a single instance which is created at startup by the ::main() function. They perform various tasks such as the creation of the main program window and openGL context, the creation of the stellarium core, the creation of the GUI. After initialization, they manage user's input event propagation and event loop. There are heavily based on %Qt features.</li>
<li>the main loop and main widget classes @em StelMainWindow and @em StelMainGraphicsView. Those classes have a single instance which is created at startup by the main() function. They perform various tasks such as the creation of the main program window and openGL context, the creation of the stellarium core, the creation of the GUI. After initialization, they manage user's input event propagation and event loop. There are heavily based on %Qt features.</li>
<li>the core which provides a number of generic services and features to the other components. The main class is the StelApp singleton class which is used everywhere in the code to access other elements. It is the StelApp instance which creates all the main core services and modules at initialization. Example services are OpenGL textures management with the StelTextureMgr, font management with the StelFontMgr, sky images management (images which have a fixed position in the sky) with the StelSkyImageMgr etc.. Two especially important manager classes (the ones with the "Mgr" suffix) are the StelModuleMgr and StelCore classes: the first one manages the collection of StelModule instances which are registered in the program (see next point for more info on what a StelModule is). The second one provides performance critical features for rendering various elements using openGL, or for computing coordinate transformation and other mathematical services.</li>
<li>a collection of StelModule instances which display the main elements of the program such as planets and stars. Each StelModule should be registered to the StelModuleMgr. Because many components of Stellarium derive from the StelModule class, it is possible for the main loop to treat them generically by calling their standard methods such StelModule::update() and StelModule::draw() at each program iteration. It also allows other program components to access them by name. StelModule can also be loaded dynamically by Stellarium, which is the standard way of creating @ref plugins.</li>
<li>the Graphical User Interface (StelGui). It is based on styled %Qt widgets which are rendered directly in the openGL window. Users actions trigger signals which are connected to core and StelModules slots.</li>
Expand Down
6 changes: 3 additions & 3 deletions doc/scripting.doxygen
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ core.wait(...);
\code
LandscapeMgr.setFlagAtmosphere(true);
\endcode
Note: All of these except for StelSkyDrawer are StelModule classes.
\note All of these except for StelSkyDrawer are StelModule classes.

@section include_scripts Includes

Expand All @@ -84,15 +84,15 @@ command:
\code
include("common_objects.inc");
\endcode
Note: Detailed example can be found <a href="http://bazaar.launchpad.net/~stellarium/stellarium/trunk/view/head:/scripts/constellations_tour.ssc">in Constellations Tour script</a>.
\note Detailed example can be found <a href="http://bazaar.launchpad.net/~stellarium/stellarium/trunk/view/head:/scripts/constellations_tour.ssc">in Constellations Tour script</a>.

@section script_console Script Console

It is possible to open, edit run and save scripts using the script console window.
To toggle the script console, press F12. The script console also provides
an output window in which script debugging output is visible.

Note: The Script Console is a build-time option. It has been enabled by
\note The Script Console is a build-time option. It has been enabled by
default since version 0.10.5. To enable or disable this feature, use the
ENABLE_SCRIPT_CONSOLE=1 or =0 option to cmake.

Expand Down
4 changes: 2 additions & 2 deletions src/core/RefractionExtinction.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class Extinction

Extinction();

//! Compute extinction effect for arrays of size @param num position vectors and magnitudes.
//! Compute extinction effect for arrays of size num position vectors and magnitudes.
//! @param altAzPos are the NORMALIZED (!!) (geometrical) star position vectors, and their z components sin(geometric_altitude).
//! This call must therefore be done before application of Refraction if atmospheric effects are on.
//! Note that forward/backward are no absolute reverse operations!
Expand All @@ -70,7 +70,7 @@ class Extinction
*mag += airmass(altAzPos[2], false) * ext_coeff;
}

//! Compute inverse extinction effect for arrays of size @param num position vectors and magnitudes.
//! Compute inverse extinction effect for arrays of size num position vectors and magnitudes.
//! @param altAzPos are the NORMALIZED (!!) (geometrical) star position vectors, and their z components sin(geometric_altitude).
//! Note that forward/backward are no absolute reverse operations!
void backward(const Vec3d& altAzPos, float* mag) const
Expand Down
2 changes: 1 addition & 1 deletion src/core/SimbadSearcher.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ class SimbadLookupReply : public QObject
Q_OBJECT
Q_ENUMS(SimbadLookupStatus)

public:
friend class SimbadSearcher;
public:

//! Possible status for a simbad query.
enum SimbadLookupStatus
Expand Down
14 changes: 5 additions & 9 deletions src/core/StelCore.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,6 @@ class StelCore : public QObject
Q_PROPERTY(bool flagUseTopocentricCoordinates READ getUseTopocentricCoordinates WRITE setUseTopocentricCoordinates)

public:
//! @enum FrameType
//! Supported reference frame types
enum FrameType
{
Expand All @@ -66,14 +65,12 @@ class StelCore : public QObject
FrameObservercentricEclipticJ2000, //!< Fixed-ecliptic reference frame centered on the Observer. GZ: was ObservercentricEcliptic, but renamed because it is Ecliptic of J2000!
FrameObservercentricEclipticOfDate, //!< Moving ecliptic reference frame centered on the Observer. GZ new for V0.14: Ecliptic of date, i.e. includes the precession of the ecliptic.
FrameEquinoxEqu, //!< Equatorial reference frame at the current equinox centered on the observer.
//!< The north pole follows the precession of the planet on which the observer is located. On Earth, this may include nutation if so configured.
//!< Has been corrected for V0.14 to really properly reflect ecliptical motion and precession (Vondrak 2011 model) and nutation.
FrameJ2000, //!< Equatorial reference frame at the J2000 equinox centered on the observer.
//!< This is also the ICRS reference frame.
//!< The north pole follows the precession of the planet on which the observer is located.
//!< On Earth, this may include nutation if so configured. Has been corrected for V0.14 to really properly reflect ecliptical motion and precession (Vondrak 2011 model) and nutation.
FrameJ2000, //!< Equatorial reference frame at the J2000 equinox centered on the observer. This is also the ICRS reference frame.
FrameGalactic //!< Galactic reference frame centered on observer.
};

//! @enum ProjectionType
//! Available projection types. A value of 1000 indicate the default projection
enum ProjectionType
{
Expand All @@ -88,7 +85,6 @@ class StelCore : public QObject
ProjectionSinusoidal //!< Sinusoidal projection
};

//! @enum RefractionMode
//! Available refraction mode.
enum RefractionMode
{
Expand All @@ -97,7 +93,6 @@ class StelCore : public QObject
RefractionOff //!< Never add refraction (i.e. geometric coordinates)
};

//! @enum DeltaTAlgorithm
//! Available DeltaT algorithms
enum DeltaTAlgorithm
{
Expand Down Expand Up @@ -127,7 +122,7 @@ class StelCore : public QObject
MorrisonStephenson2004, //!< Morrison & Stephenson (2004, 2005) algorithm for DeltaT
Reijs, //!< Reijs (2006) algorithm for DeltaT
EspenakMeeus, //!< Espenak & Meeus (2006) algorithm for DeltaT (Recommended, default)
EspenakMeeusZeroMoonAccel, // Espenak & Meeus (2006) algorithm for DeltaT (but without additional Lunar acceleration. FOR TESTING ONLY, NONPUBLIC)
EspenakMeeusZeroMoonAccel, //!< Espenak & Meeus (2006) algorithm for DeltaT (but without additional Lunar acceleration. FOR TESTING ONLY, NONPUBLIC)
Banjevic, //!< Banjevic (2006) algorithm for DeltaT
IslamSadiqQureshi, //!< Islam, Sadiq & Qureshi (2008 + revisited 2013) algorithm for DeltaT (6 polynomials)
KhalidSultanaZaidi, //!< M. Khalid, Mariam Sultana and Faheem Zaidi polinomial approximation of time period 1620-2013 (2014)
Expand Down Expand Up @@ -313,6 +308,7 @@ class StelCore : public QObject
QString getDefaultProjectionTypeKey(void) const;

public slots:

//! Set the current ProjectionType to use
void setCurrentProjectionType(ProjectionType type);
ProjectionType getCurrentProjectionType() const;
Expand Down
9 changes: 5 additions & 4 deletions src/core/StelMovementMgr.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -163,10 +163,11 @@ public slots:
//! @param aimUp Up vector. Can be usually (0/0/1) but may have to be exact for looking into the zenith/pole
//! @param moveDuration The time it takes for the move to complete.
//! @param zooming you want to zoom in, out or not (just center).
//! @example You can use the following code most of the times to find a valid aimUp vector:
//! StelMovementMgr* mvmgr = GETSTELMODULE(StelMovementMgr);
//! mvmgr->moveToJ2000(pos, mvmgr->mountFrameToJ2000(Vec3d(0., 0., 1.)), mvmgr->getAutoMoveDuration());
//!
//! @code
//! // You can use the following code most of the times to find a valid aimUp vector:
//! StelMovementMgr* mvmgr = GETSTELMODULE(StelMovementMgr);
//! mvmgr->moveToJ2000(pos, mvmgr->mountFrameToJ2000(Vec3d(0., 0., 1.)), mvmgr->getAutoMoveDuration());
//! @endcode
void moveToJ2000(const Vec3d& aim, const Vec3d &aimUp, float moveDuration = 1., ZoomingMode zooming = ZoomNone);
void moveToObject(const StelObjectP& target, float moveDuration = 1., ZoomingMode zooming = ZoomNone);

Expand Down
6 changes: 4 additions & 2 deletions src/core/StelVideoMgr.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,10 @@ class QGraphicsVideoItem;
//! We opted for the latter solution because it allows scaled but undistorted video frames which may also take current screen resolution into account.
//!
//! Under unclear circumstances we also have a pair of messages:
//! @code Failed to start video surface due to main thread blocked.
//! @code Failed to start video surface
//! @code
//! Failed to start video surface due to main thread blocked.
//! Failed to start video surface
//! @endcode
//! and non-appearing video frame, this seems to be https://bugreports.qt.io/browse/QTBUG-39567.
//! This occurred on an Intel NUC5i3 with SSD, so loading the file should not be much of an issue.
//!
Expand Down
10 changes: 5 additions & 5 deletions src/core/modules/Constellation.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ class StelPainter;
//! @class Constellation
//! The Constellation class models a grouping of stars in a Sky Culture.
//! Each Constellation consists of a list of stars identified by their
//! @var abbreviation and Hipparcos catalogue numbers (taken from @file: constellationship.fab),
//! another entry in @file constellation_names.eng.fab with the defining abbreviated name,
//! @var nativeName, and translatable @var englishName (translation goes into @var nameI18),
//! boundary shape from @file constellations_boundaries.dat and an (optional) artistic pictorial representation.
//! GZ NEW: The @var nativeName should be accessible in a GUI option, so that e.g. original names as written in a
//! abbreviation and Hipparcos catalogue numbers (taken from file: constellationship.fab),
//! another entry in file constellation_names.eng.fab with the defining abbreviated name,
//! nativeName, and translatable englishName (translation goes into nameI18),
//! boundary shape from file constellations_boundaries.dat and an (optional) artistic pictorial representation.
//! GZ NEW: The nativeName should be accessible in a GUI option, so that e.g. original names as written in a
//! concrete book where a skyculture has been taken from can be assured even when translation is available.
//! TODO: There should be a distinction between constellations and asterisms, which are "inofficial" figures within a sky culture.
//! For example, Western sky culture has a "Big Dipper", "Coathanger", etc. These would be nice to see, but in different style.
Expand Down
2 changes: 1 addition & 1 deletion src/core/modules/StarMgr.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ public slots:
//! Get the (English) common name for a star with a specified
//! Hipparcos catalogue number.
//! @param hip The Hipparcos number of star
//! @return common name of star (from skyculture @file star_names.fab)
//! @return common name of star (from skyculture file star_names.fab)
static QString getCommonEnglishName(int hip);

//! Get the cross-index designations for a star with a specified
Expand Down
1 change: 0 additions & 1 deletion src/gui/SearchDialog.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ class SearchDialog : public StelDialog
Q_ENUMS(CoordinateSystem)

public:
//! @enum CoordinateSystem
//! Available coordinate systems
enum CoordinateSystem
{
Expand Down

0 comments on commit bb4eca1

Please sign in to comment.