X-Git-Url: http://git.tdb.fi/?p=libs%2Fcore.git;a=blobdiff_plain;f=source%2Fcore%2Fapplication.h;h=1384085ef58c3b134b9aa0abecbc68fcbd9d7e9e;hp=7dfea8a0ad13abaa05d3102ace97a0962e957fd4;hb=b2333b53a0434eb6a131000c0b9bf06e4f603bd6;hpb=c200fbb2a7c00f9506933ed67d55cae30475998d

diff --git a/source/core/application.h b/source/core/application.h
index 7dfea8a..1384085 100644
--- a/source/core/application.h
+++ b/source/core/application.h
@@ -36,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);
 
 	static void display_exception(const std::exception &);