[mb-commits] r8453 - in libmusicbrainz/branches/xmlws: . include/musicbrainz3

Author: luks
Date: 2006-08-30 19:24:03 +0000 (Wed, 30 Aug 2006)
New Revision: 8453

Modified:
   libmusicbrainz/branches/xmlws/INSTALL
   libmusicbrainz/branches/xmlws/SConstruct
   libmusicbrainz/branches/xmlws/include/musicbrainz3/filters.h
   libmusicbrainz/branches/xmlws/include/musicbrainz3/includes.h
   libmusicbrainz/branches/xmlws/include/musicbrainz3/mb_c.h
   libmusicbrainz/branches/xmlws/include/musicbrainz3/webservice.h
Log:
Documentation fixes

Modified: libmusicbrainz/branches/xmlws/INSTALL
===================================================================
--- libmusicbrainz/branches/xmlws/INSTALL       2006-08-30 19:17:07 UTC (rev 
8452)
+++ libmusicbrainz/branches/xmlws/INSTALL       2006-08-30 19:24:03 UTC (rev 
8453)
@@ -4,22 +4,22 @@
   The instructions in this file should help you to build and install the
   MusicBrainz client library from source on your system.
 
-Required Libraries
-==================
+Dependencies
+============
 
   Before you start, make sure you have installed following libraries:
 
   * Neon -- HTTP client library
     http://www.webdav.org/neon/
     
-  * CppUnit -- C++ unit testing framework
+  * (optional) CppUnit -- C++ unit testing framework
     http://cppunit.sourceforge.net/cppunit-wiki
     Only required to compile and run the test suite.
     
 Building on *nix
 ================
 
-  Once you have installed Neon, and optionally CppUnit, you can compile the
+  Once you have installed all dependencies, you can compile the
   library:
     
     $ ./configure

Modified: libmusicbrainz/branches/xmlws/SConstruct
===================================================================
--- libmusicbrainz/branches/xmlws/SConstruct    2006-08-30 19:17:07 UTC (rev 
8452)
+++ libmusicbrainz/branches/xmlws/SConstruct    2006-08-30 19:24:03 UTC (rev 
8453)
@@ -27,6 +27,7 @@
 
 env.Append(CPPPATH=['#.', '#include'])
 
+env.Append(CPPDEFINES=['HAVE_CONFIG_H'])
 if env['PLATFORM'] == 'win32':
     env.Append(CPPDEFINES=['WIN32', '_WINDOWS'])
 

Modified: libmusicbrainz/branches/xmlws/include/musicbrainz3/filters.h
===================================================================
--- libmusicbrainz/branches/xmlws/include/musicbrainz3/filters.h        
2006-08-30 19:17:07 UTC (rev 8452)
+++ libmusicbrainz/branches/xmlws/include/musicbrainz3/filters.h        
2006-08-30 19:24:03 UTC (rev 8453)
@@ -32,7 +32,7 @@
 {
 
        /**
-     * A filter for collections.
+        * A filter for collections.
         *
         * This is the interface all filters have to implement. 
         */

Modified: libmusicbrainz/branches/xmlws/include/musicbrainz3/includes.h
===================================================================
--- libmusicbrainz/branches/xmlws/include/musicbrainz3/includes.h       
2006-08-30 19:17:07 UTC (rev 8452)
+++ libmusicbrainz/branches/xmlws/include/musicbrainz3/includes.h       
2006-08-30 19:24:03 UTC (rev 8453)
@@ -31,7 +31,7 @@
 {
 
        /**
-     * An interface implemented by include tag generators.
+        * An interface implemented by include tag generators.
         */
        class MB_API IIncludes
        {

Modified: libmusicbrainz/branches/xmlws/include/musicbrainz3/mb_c.h
===================================================================
--- libmusicbrainz/branches/xmlws/include/musicbrainz3/mb_c.h   2006-08-30 
19:17:07 UTC (rev 8452)
+++ libmusicbrainz/branches/xmlws/include/musicbrainz3/mb_c.h   2006-08-30 
19:24:03 UTC (rev 8453)
@@ -29,13 +29,6 @@
 
 #include <musicbrainz3/defines.h>
 
-/*
-  TODO:
-   * Error handling? 
-     * Error messages
-   * Returning of lists?
-*/
-
 /* {{{ Typedefs */
 
 typedef void *MbArtist;

Modified: libmusicbrainz/branches/xmlws/include/musicbrainz3/webservice.h
===================================================================
--- libmusicbrainz/branches/xmlws/include/musicbrainz3/webservice.h     
2006-08-30 19:17:07 UTC (rev 8452)
+++ libmusicbrainz/branches/xmlws/include/musicbrainz3/webservice.h     
2006-08-30 19:24:03 UTC (rev 8453)
@@ -150,34 +150,144 @@
                 */
                virtual ~WebService();
                
+               /**
+                * Sets the host. 
+                *
+                * @param host a string containing the host name   
+                */
                void setHost(const std::string &host);
+               
+               /**
+                * Returns the host.
+                *
+                * @return a string containing the host name  
+                */
                std::string getHost() const;
                
+               /**
+                * Sets the port. 
+                *
+                * @param port an int containing the port number   
+                */
                void setPort(const int port);
+               
+               /**
+                * Returns the port.
+                *
+                * @return an int containing the port number  
+                */
                int getPort() const;
                
+               /**
+                * Sets the path prefix. 
+                *
+                * @param pathPrefix a string containing the path prefix  
+                */
                void setPathPrefix(const std::string &pathPrefix);
+               
+               /**
+                * Returns the path prefix.
+                *
+                * @return a string containing the path prefix  
+                */
                std::string getPathPrefix() const;
                
+               /**
+                * Sets the MusicBrainz user name. 
+                *
+                * @param username a string containing the user name  
+                */
                void setUserName(const std::string &username);
+               
+               /**
+                * Returns the MusicBrainz user name.
+                *
+                * @return a string containing the user name 
+                */
                std::string getUserName() const;
                
+               /**
+                * Sets the MusicBrainz user password. 
+                *
+                * @param password a string containing the user password  
+                */
                void setPassword(const std::string &password);
+               
+               /**
+                * Returns the MusicBrainz user password.
+                *
+                * @return a string containing the user password 
+                */
                std::string getPassword() const;
                
+               /**
+                * Sets the HTTP authentification realm. 
+                *
+                * @param password a string containing the realm 
+                */
                void setRealm(const std::string &realm);
+               
+               /**
+                * Returns the HTTP authentification realm.
+                *
+                * @return a string containing the realm 
+                */
                std::string getRealm() const;
                
+               /**
+                * Sets the proxy host. 
+                *
+                * @param host a string containing the host name   
+                */
                void setProxyHost(const std::string &host);
+               
+               /**
+                * Returns the proxy host.
+                *
+                * @return a string containing the host name  
+                */
                std::string getProxyHost() const;
                
+               /**
+                * Sets the proxy port. 
+                *
+                * @param port an int containing the port number   
+                */
                void setProxyPort(const int port);
+               
+               /**
+                * Returns the proxy port.
+                *
+                * @return an int containing the port number  
+                */
                int getProxyPort() const;
                
+               /**
+                * Sets the proxy user name. 
+                *
+                * @param username a string containing the user name   
+                */
                void setProxyUserName(const std::string &username);
+               
+               /**
+                * Returns the proxy user name.
+                *
+                * @return a string containing the user name  
+                */
                std::string getProxyUserName() const;
                
+               /**
+                * Sets the proxy password. 
+                *
+                * @param password a string containing the password   
+                */
                void setProxyPassword(const std::string &password);
+               
+               /**
+                * Returns the proxy password.
+                *
+                * @return a string containing the password  
+                */
                std::string getProxyPassword() const;
                
                /**