[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    KDE/kdelibs/kabc
From:       Thomas Kadauke <tkadauke () gmx ! de>
Date:       2005-10-31 22:02:48
Message-ID: 1130796168.079066.31366.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 476219 by tkadauke:

DOX: enabled sortmode.h documentation


 M  +24 -4     sortmode.h  


--- trunk/KDE/kdelibs/kabc/sortmode.h #476218:476219
@@ -44,14 +44,22 @@
     virtual bool lesser( const KABC::Addressee &first, const KABC::Addressee &second ) const = 0;
 };
 
+/**
+  @short Implements comparison by name.
+
+  This class implements a comparison of two Addressee objects by name.
+ */
 class KABC_EXPORT NameSortMode : public SortMode
 {
   public:
+    /**
+      Specifies which parts of the name are used for comparison.
+     */
     enum NameType
     {
-      FormattedName,
-      FamilyName,
-      GivenName
+      FormattedName,    ///< use the formatted name, e.g. "John Doe"
+      FamilyName,       ///< use the last name, e.g. "Doe"
+      GivenName         ///< use the first name, e.g. "John"
     };
 
     /**
@@ -67,6 +75,9 @@
       Creates a NameSortMethod with the specified name type.
 
       @param type The name type.
+      @param ascending if @c true, Addressee object are sorted in
+             ascending order; if @c false, objects are sorted in
+             descending order
      */
     NameSortMode( NameType type, bool ascending = true );
 
@@ -83,15 +94,24 @@
     NameSortModePrivate *d;
 };
 
+/**
+  @short Implements comparison by an arbitrary field.
+
+  This class implements a comparison of two Addressee objects by the
+  value of an arbitrary field.
+ */
 class KABC_EXPORT FieldSortMode : public SortMode
 {
   public:
     /**
       Constructor.
 
-      Creates a FieldSortMethod with the specified field.
+      Creates a FieldSortMethod with the specified @p field.
 
       @param field The field.
+      @param ascending if @c true, Addressee object are sorted in
+             ascending order; if @c false, objects are sorted in
+             descending order
      */
     FieldSortMode( KABC::Field *field, bool ascending = true );
 	virtual ~FieldSortMode(){}
[prev in list] [next in list] [prev in thread] [next in thread]