From 1fa480b1a7180bba6bc066d04ef0e4c64b2f9bc1 Mon Sep 17 00:00:00 2001
From: Matt Douhan <matt@fruitsalad.org>
Date: Wed, 27 Jul 2005 19:23:27 +0000
Subject: [PATCH] Add proper API dox

must keep Ade happy, it is vital :)

svn path=/branches/KDE/3.5/kdepim/; revision=439331
---
 kmkernel.h | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/kmkernel.h b/kmkernel.h
index bb0af7571..cd6926af3 100644
--- a/kmkernel.h
+++ b/kmkernel.h
@@ -178,13 +178,28 @@ public:
   virtual QString getFrom( Q_UINT32 serialNumber );
   int viewMessage( const KURL & messageFile );
 
+  /**
+   * Pauses all background jobs and does not
+   * allow new background jobs to be started.
+  */
   virtual void pauseBackgroundJobs();
+
+  /**
+   * Resumes all background jobs and allows
+   * new jobs to be started.
+  */
   virtual void resumeBackgroundJobs();
 
-  /** Stop all network related jobs and enter offline mode */
+  /** 
+   * Stops all network related jobs and enter offline mode 
+   * New network jobs cannot be started. 
+  */
   void stopNetworkJobs();
 
-  /** Resume all network related jobs and enter online mode */
+  /**
+   * Resumes all network related jobs and enter online mode
+   * New network jobs can be started.
+  */
   void resumeNetworkJobs();
 
   /** A static helper function that asks the user