From d80c5e60a4d07b15f043341674246eae0cc2d9a9 Mon Sep 17 00:00:00 2001
From: twanvl <twanvl@0fc631ac-6414-0410-93d0-97cfa31319b6>
Date: Sat, 31 May 2008 12:57:32 +0000
Subject: [PATCH] Just commenting

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@902 0fc631ac-6414-0410-93d0-97cfa31319b6
---
 src/data/installer.hpp      | 10 ++++++++--
 src/gui/packages_window.cpp |  2 ++
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/src/data/installer.hpp b/src/data/installer.hpp
index 73ab970f..dffd8640 100644
--- a/src/data/installer.hpp
+++ b/src/data/installer.hpp
@@ -21,9 +21,11 @@ DECLARE_POINTER_TYPE(InstallablePackage);
 // ----------------------------------------------------------------------------- : Installer
 
 /// A package that contains other packages that can be installed
+/** Installers will be sent around the internet, etc. so they are fairly selfcontained.
+ */
 class Installer : public Packaged {
   public:
-	String prefered_filename;	///< What filename should be used (by default)
+	String prefered_filename;	///< What filename should be used (by default), when creating the installer
 	vector<PackageDescriptionP> packages;	///< Packages to install
 	
 	/// Add a package to the installer (if it is not already added).
@@ -41,7 +43,10 @@ class Installer : public Packaged {
 
 // ----------------------------------------------------------------------------- : Installer descriptions
 
-/// A description of a package in an installer
+/// A description of a package in an installer.
+/** This is essentially the same information as in a Packaged object.
+ *  TODO: try to merge these!
+ */
 class PackageDescription : public IntrusivePtrBase<PackageDescription> {
   public:
 	PackageDescription();
@@ -59,6 +64,7 @@ class PackageDescription : public IntrusivePtrBase<PackageDescription> {
 	vector<PackageDependencyP> dependencies;	///< Dependencies of this package
 	
 	/// Merge two descriptions a package. This package takes precedence
+	/** Usually one of the descriptions will refer to the locally installed one, the other to the new one */
 	void merge(const PackageDescription& p2);
 	
 	DECLARE_REFLECTION();
diff --git a/src/gui/packages_window.cpp b/src/gui/packages_window.cpp
index dd24f942..4d79fe4b 100644
--- a/src/gui/packages_window.cpp
+++ b/src/gui/packages_window.cpp
@@ -48,6 +48,7 @@ struct HtmlWindowToBrowser : public wxHtmlWindow {
 
 // ----------------------------------------------------------------------------- : DownloadableInstallers
 
+/// Handle downloading of installers
 class DownloadableInstallerList {
   public:
 	DownloadableInstallerList() : status(NONE) {}
@@ -66,6 +67,7 @@ class DownloadableInstallerList {
 	};
 };
 
+/// The global installer downloader
 DownloadableInstallerList downloadable_installers;
 
 bool DownloadableInstallerList::done() {