From: Mikko Rasa <tdb@tdb.fi>
Date: Fri, 4 Oct 2013 19:26:07 +0000 (+0300)
Subject: Move Application member documentation to the header
X-Git-Url: http://git.tdb.fi/?p=libs%2Fcore.git;a=commitdiff_plain;h=b2333b53a0434eb6a131000c0b9bf06e4f603bd6

Move Application member documentation to the header
---

diff --git a/source/core/application.cpp b/source/core/application.cpp
index 36621e9..ebd928b 100644
--- a/source/core/application.cpp
+++ b/source/core/application.cpp
@@ -15,14 +15,6 @@ Application::Application():
 	exit_code(0)
 { }
 
-/**
-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.
-*/
 int Application::run(int argc, char **argv, void *data)
 {
 	static bool called = false;
@@ -69,10 +61,6 @@ int Application::run(int argc, char **argv, void *data)
 	}
 }
 
-/**
-Default main loop.  Calls tick() repeatedly until exit() is called.  A custom
-main loop should monitor the done member variable and return exit_code.
-*/
 int Application::main()
 {
 	done = false;
@@ -82,26 +70,17 @@ int Application::main()
 	return exit_code;
 }
 
-/**
-Sets the specified signal to be delivered to the sighandler member function.
-*/
 void Application::catch_signal(int s)
 {
 	signal(s, &sighandler_);
 }
 
-/**
-Causes the application to exit gracefully with the given exit code.
-*/
 void Application::exit(int c)
 {
 	done = true;
 	exit_code = c;
 }
 
-/**
-Static wrapper function to call a member function of the Application instance.
-*/
 void Application::sighandler_(int s)
 {
 	app_->sighandler(s);
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 &);