summaryrefslogtreecommitdiffstats
path: root/libmultimc/include/instversion.h
diff options
context:
space:
mode:
authorAndrew <forkk@forkk.net>2013-03-08 13:56:26 -0600
committerAndrew <forkk@forkk.net>2013-03-08 13:56:26 -0600
commit2d6e785e4ee8a8b837fe84f83972ec23a09564af (patch)
tree6afdac6e06f1ba8ae5c29f62b5a4a9bc1b696b12 /libmultimc/include/instversion.h
parent69040f923b0344de214d6f1fc4553d223df7d2d6 (diff)
downloadMultiMC-2d6e785e4ee8a8b837fe84f83972ec23a09564af.tar
MultiMC-2d6e785e4ee8a8b837fe84f83972ec23a09564af.tar.gz
MultiMC-2d6e785e4ee8a8b837fe84f83972ec23a09564af.tar.lz
MultiMC-2d6e785e4ee8a8b837fe84f83972ec23a09564af.tar.xz
MultiMC-2d6e785e4ee8a8b837fe84f83972ec23a09564af.zip
Implemented version lists.
Diffstat (limited to 'libmultimc/include/instversion.h')
-rw-r--r--libmultimc/include/instversion.h33
1 files changed, 19 insertions, 14 deletions
diff --git a/libmultimc/include/instversion.h b/libmultimc/include/instversion.h
index 3c6b7ac9..7de83966 100644
--- a/libmultimc/include/instversion.h
+++ b/libmultimc/include/instversion.h
@@ -26,27 +26,32 @@ class LIBMULTIMC_EXPORT InstVersion : public QObject
{
Q_OBJECT
public:
- // Constructs a new InstVersion with the given parent. The parent *must*
- // be the InstVersionList that contains this InstVersion. The InstVersion
- // should be added to the list immediately after being created as any calls
- // to id() will likely fail unless the InstVersion is in a list.
+ /*!
+ * \brief Constructs a new InstVersion with the given parent.
+ * The parent *must* be the InstVersionList that contains this InstVersion.
+ * The InstVersion should be added to the list immediately after being created.
+ */
explicit InstVersion(InstVersionList *parent = 0);
- // Returns this InstVersion's ID. This is usually just the InstVersion's index
- // within its InstVersionList, but not always.
- // If this InstVersion is not in an InstVersionList, returns -1.
- virtual int id() const = 0;
+ //! Gets the string used to identify this version in config files.
+ virtual QString descriptor() const = 0;
+
+ /*!
+ * \breif Returns this InstVersion's name.
+ * This is displayed to the user in the GUI and is usually just the version number ("1.4.7"), for example.
+ */
- // Returns this InstVersion's name. This is displayed to the user in the GUI
- // and is usually just the version number ("1.4.7"), for example.
virtual QString name() const = 0;
- // Returns this InstVersion's name. This is usually displayed to the user
- // in the GUI and specifies what kind of version this is. For example: it
- // could be "Snapshot", "Latest Version", "MCNostalgia", etc.
+ /*!
+ * \brief Returns this InstVersion's name.
+ * This is usually displayed to the user in the GUI and specifies what
+ * kind of version this is. For example: it could be "Snapshot",
+ * "Latest Version", "MCNostalgia", etc.
+ */
virtual QString type() const = 0;
- // Returns the version list that this InstVersion is a part of.
+ //! Returns the version list that this InstVersion is a part of.
virtual InstVersionList *versionList() const;
};