From 2d245fcabb385347359759de8e6c40ce16e43cab Mon Sep 17 00:00:00 2001
From: Denis Loh <denis.loh@gmail.com>
Date: Thu, 19 Nov 2009 12:21:55 +0100
Subject: Added options for verbosity level and auto detect settings

---
 upnp.h | 80 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 79 insertions(+), 1 deletion(-)

(limited to 'upnp.h')

diff --git a/upnp.h b/upnp.h
index 5baa1cc..ab1b04a 100644
--- a/upnp.h
+++ b/upnp.h
@@ -15,6 +15,12 @@
 
 class cUPnPServer;
 
+/**
+ * The UPnP/DLNA plugin
+ *
+ * This is a UPnP/DLNA media server plugin. It supports live-TV and recordings
+ * of the VDR as well as custom video files.
+ */
 class cPluginUpnp : public cPlugin {
 private:
     // Add any member variables or functions you may need here.
@@ -23,20 +29,92 @@ private:
 public:
     cPluginUpnp(void);
     virtual ~cPluginUpnp();
+    /**
+     * Get the version of the plugin
+     *
+     * Returns the version string of the plugin
+     *
+     * @return a string representation of the plugin version
+     */
     virtual const char *Version(void);
+    /**
+     * Get the description
+     *
+     * This returns a brief description of the plugin and what it does.
+     *
+     * @return the description of the plugin
+     */
     virtual const char *Description(void);
+    /**
+     * Get the command line help
+     *
+     * This returns the command line help output, which comes, when the user
+     * types \c --help into the command line.
+     *
+     * @return the command line help
+     */
     virtual const char *CommandLineHelp(void);
+    /*! @copydoc cUPnPConfig::processArgs */
     virtual bool ProcessArgs(int argc, char *argv[]);
+    /**
+     * Initializes the plugin
+     *
+     * This initializes any background activities of the plugin.
+     *
+     * @return returns
+     * - \bc true, if initializing was successful
+     * - \bc false, otherwise
+     */
     virtual bool Initialize(void);
+    /**
+     * Starts the plugin
+     *
+     * This starts the plugin. It starts additional threads, which are required
+     * by the plugin.
+     *
+     * @return returns
+     * - \bc true, if starting was successful
+     * - \bc false, otherwise
+     */
     virtual bool Start(void);
+    /**
+     * Stops the plugin
+     *
+     * This stops the plugin and all its components
+     */
     virtual void Stop(void);
+    /**
+     * Message if still active
+     *
+     * This returns a message if the plugin is still active when a user attempts
+     * to shut down the VDR.
+     *
+     * @return the message shown on the screen.
+     */
     virtual cString Active(void);
+    /**
+     * Setup menu
+     *
+     * This creates a new instance of the setup menu, which is shown to the user
+     * when he enters the VDR plugin setup menu
+     *
+     * @return the menu of the plugin
+     */
     virtual cMenuSetupPage *SetupMenu(void);
+    /*! @copydoc cUPnPConfig::parseSetup */
     virtual bool SetupParse(const char *Name, const char *Value);
+    /**
+     * Get the configuration directory
+     *
+     * This returns the directory, where configuration files are stored.
+     *
+     * @return the directory of the configuration files.
+     */
     static const char* getConfigDirectory();
 };
 
-extern cCondWait DatabaseLocker;
+extern cCondWait DatabaseLocker;        ///< Locks the database to be loaded only if
+                                        ///< the configuration file directory is set
 
 #endif	/* _UPNP_H */
 
-- 
cgit v1.2.3