Move Application member documentation to the header

[libs/core.git] / source / core / application.cpp

diff --git a/source/core/application.cpp b/source/core/application.cpp
index 36621e92ae99af9b74a2726263fd3b8176cbd020..ebd928b7b7ce049cd2d33ebcedba2ab8f8d4f190 100644 (file)
--- a/source/core/application.cpp
+++ b/source/core/application.cpp
@@ -15,14 +15,6 @@ Application::Application():
        exit_code(0)
 { }
 
        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;
 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;
 int Application::main()
 {
        done = false;


@@ -82,26 +70,17 @@ int Application::main()
        return exit_code;
 }
 
        return exit_code;
 }
 

-/**
-Sets the specified signal to be delivered to the sighandler member function.
-*/

 void Application::catch_signal(int s)
 {
        signal(s, &sighandler_);
 }
 
 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;
 }
 
 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);
 void Application::sighandler_(int s)
 {
        app_->sighandler(s);