Fix Build-Depends in debian/control

[senf.git] / Utils / Daemon / Mainpage.dox

diff --git a/Utils/Daemon/Mainpage.dox b/Utils/Daemon/Mainpage.dox
index ffde18d..e73b224 100644 (file)
--- a/Utils/Daemon/Mainpage.dox
+++ b/Utils/Daemon/Mainpage.dox
@@ -1,8 +1,8 @@
 // $Id$
 //
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer NETwork research (NET)
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
@@ -26,6 +26,8 @@
     process is implemented by deriving from senf::Daemon and implementing the necessary (virtual)
     member functions.
     \code
+    #include <senf/Utils/Daemon.hh>
+    
     class MyDaemon : public senf::Daemon
     {
         void configure() {
@@ -36,7 +38,7 @@
             // here after setting default parameters
             senf::Daemon::configure();
         }
-
+    
         void init() {
             // Initialize application. Setup all necessary objects. After init()
             // has completed, the startup should not fail
@@ -63,7 +65,37 @@
     Since there are times, where separating init() and run() into two separate functions is
     difficult, instead of defining init() and run(), the member main() may be defined. This member
     must call detach() as soon as initialization is completed to detach from the foreground
-    terminal.
+    terminal.    
+    \code
+    #include <senf/Utils/Daemon.hh>
+    
+    class MyDaemon : public senf::Daemon
+    {
+        // 'configure()' like above. Don't implement 'init()' or 'run()' if you implement 'main()'.
+
+        void main() {
+            // Initialize application. Setup all necessary objects. When implementing main(), the
+            // objects will most often live on the stack.
+
+            MyAppObject app;
+
+            if (some_error)
+                // Call Daemon::exit() to terminate execution prematurely
+                exit(1);
+
+            // After initialization is complete, you *must* call 'detach()'.
+
+            detach()
+
+            // Now we can start the application main loop
+
+            app.run();
+        }
+    };
+
+    // Provide main() function
+    SENF_DAEMON_MAIN(MyDaemon);
+    \endcode
 
     \see 
         \ref senf::Daemon class \n