ccba6d73f9
Fix wrong use of Doxygen grouping-related markup which somehow worked in older Doxygen versions, but doesn't work any longer. This fixes the problem with the "Functions by Category" pages being empty in the resulting HTML documentation and wrong documentation being shown for a bunch of wxString members. This is a combined cherry-pick of the following master commits: bd92523bc5 Fix use of Doxygen @addtogroup command 4c46e01b14 Remove stray Doxygen end group marker 8ac10d28f8 Fix all the other comments with Doxygen grouping commands too c0f1ecf263 Fix another unbalanced Doxygen grouping command after last commit See #22248, #22572.
147 lines
3.8 KiB
Objective-C
147 lines
3.8 KiB
Objective-C
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: versioninfo.h
|
|
// Purpose: interface of wxVersionInfo
|
|
// Author: Troels K
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
@class wxVersionInfo
|
|
|
|
wxVersionInfo contains version information.
|
|
|
|
This class is used by wxWidgets to provide version information about the
|
|
libraries it uses and itself, but you can also apply it in user space, to
|
|
provide version information about your own libraries, or other libraries
|
|
that you use.
|
|
|
|
@library{wxbase}
|
|
|
|
@category{data}
|
|
|
|
@since 2.9.2
|
|
*/
|
|
class wxVersionInfo
|
|
{
|
|
public:
|
|
/**
|
|
Constructor.
|
|
|
|
The version information objects need to be initialized with this
|
|
constructor and are immutable once they are created.
|
|
|
|
@param name The name of the library or other entity that this object
|
|
pertains to.
|
|
@param major The major version component.
|
|
@param minor The minor version component.
|
|
@param micro The micro version component, 0 by default.
|
|
@param revision The revision version component, also known as "build
|
|
number". This component is also 0 by default and is only available
|
|
since wxWidgets 3.2.0.
|
|
@param description Free form description of this version, none by
|
|
default.
|
|
@param copyright Copyright string, none by default.
|
|
*/
|
|
wxVersionInfo(const wxString& name = wxString(),
|
|
int major = 0,
|
|
int minor = 0,
|
|
int micro = 0,
|
|
int revision = 0,
|
|
const wxString& description = wxString(),
|
|
const wxString& copyright = wxString());
|
|
|
|
/**
|
|
Get the name of the object (library).
|
|
|
|
@return Name string.
|
|
*/
|
|
const wxString& GetName() const;
|
|
|
|
/**
|
|
Get the major version number.
|
|
|
|
@return Major version number.
|
|
*/
|
|
int GetMajor() const;
|
|
|
|
/**
|
|
Get the minor version number.
|
|
|
|
@return Minor version number.
|
|
*/
|
|
int GetMinor() const;
|
|
|
|
/**
|
|
Get the micro version, or release number.
|
|
|
|
This is the third component of the version.
|
|
|
|
@return Micro version, or release number.
|
|
*/
|
|
int GetMicro() const;
|
|
|
|
/**
|
|
Get the revision version, or build number.
|
|
|
|
This is the fourth component of the version.
|
|
|
|
@return Revision version, or build number.
|
|
|
|
@since 3.2.0
|
|
*/
|
|
int GetRevision() const;
|
|
|
|
/**
|
|
Get the string representation of this version object.
|
|
|
|
This function returns the description if it is non-empty or
|
|
GetVersionString() if there is no description.
|
|
|
|
@see GetDescription(), GetVersionString()
|
|
*/
|
|
wxString ToString() const;
|
|
|
|
/**
|
|
Get the string representation.
|
|
|
|
The micro and revision components of the version are ignored/not used
|
|
if they are both zero. If the revision component is non-zero all four
|
|
parts will be used even if the micro component is zero.
|
|
|
|
@return The version string in the form "name major.minor[.micro[.revision]]".
|
|
*/
|
|
wxString GetVersionString() const;
|
|
|
|
/**
|
|
Return @true if a description string has been specified.
|
|
|
|
@see GetDescription()
|
|
*/
|
|
bool HasDescription() const;
|
|
|
|
/**
|
|
Get the description string.
|
|
|
|
The description may be empty.
|
|
|
|
@return The description string, free-form.
|
|
*/
|
|
const wxString& GetDescription();
|
|
|
|
/**
|
|
Returns @true if a copyright string has been specified.
|
|
|
|
@see GetCopyright()
|
|
*/
|
|
bool HasCopyright() const;
|
|
|
|
/**
|
|
Get the copyright string.
|
|
|
|
The copyright string may be empty.
|
|
|
|
@return The copyright string.
|
|
*/
|
|
const wxString& GetCopyright() const;
|
|
};
|