Move Application member documentation to the header
authorMikko Rasa <tdb@tdb.fi>
Fri, 4 Oct 2013 19:26:07 +0000 (22:26 +0300)
committerMikko Rasa <tdb@tdb.fi>
Fri, 4 Oct 2013 19:26:07 +0000 (22:26 +0300)
source/core/application.cpp
source/core/application.h

index 36621e92ae99af9b74a2726263fd3b8176cbd020..ebd928b7b7ce049cd2d33ebcedba2ab8f8d4f190 100644 (file)
@@ -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);
index 7dfea8a0ad13abaa05d3102ace97a0962e957fd4..1384085ef58c3b134b9aa0abecbc68fcbd9d7e9e 100644 (file)
@@ -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 &);