X-Git-Url: http://git.tdb.fi/?p=libs%2Fcore.git;a=blobdiff_plain;f=source%2Fcore%2Fapplication.h;h=e1d3a8b5e2be95d0c2fd0ffce151a1347264f080;hp=08393b724b486077452e9ffb940bd9822fc6578c;hb=f042fd992170ee8a50a7f596f1c9cdd9600b8583;hpb=d16185720fa344263367dbd50c61bfc8183d99a4

diff --git a/source/core/application.h b/source/core/application.h
index 08393b7..e1d3a8b 100644
--- a/source/core/application.h
+++ b/source/core/application.h
@@ -1,6 +1,8 @@
 #ifndef MSP_CORE_APPLICATION_H_
 #define MSP_CORE_APPLICATION_H_
 
+#include <stdexcept>
+
 namespace Msp {
 
 /**
@@ -34,16 +36,35 @@ protected:
 public:
 	virtual ~Application() { }
 
+	/** Constructs an instance of the registered application class and runs it.
+	If the application throws a usage_error, a help message is printed.  The
+	GetOpt class will throw such exceptions automatically in error conditions.
+
+	This function can only be called once.  The global main() function provided
+	by the library normally does it automatically at program startup. */
 	static int run(int, char **, void * =0);
+
 	static void *get_data() { return data_; }
 
 protected:
+	/** Default main loop.  Calls tick() repeatedly until exit() is called.  A
+	custom main loop should monitor the done member variable and return
+	exit_code. */
 	virtual int main();
+
+	/** Sets the specified signal to be delivered to the sighandler member
+	function. */
 	void catch_signal(int);
+
+	/** Causes the application to exit gracefully with the given exit code. */
 	void exit(int);
+
 	virtual void tick() { }
 	virtual void sighandler(int) { }
+
 private:
+	/** Static wrapper function to call a member function of the Application
+	instance. */
 	static void sighandler_(int);
 };