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

List:       kde-commits
Subject:    KDE/kdelibs
From:       Matt Williams <matt () milliams ! com>
Date:       2008-04-30 18:01:31
Message-ID: 1209578491.100533.7163.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 802811 by milliams:

- Add information about which 'class-include' (e.g. <KUser> rather than <kuser.h>) to \
                use to the apidox. Only kdecore/utils, kdecore/io and kdecore/config \
                so far
- Add a class-include for KAutoSaveFile since it was missing

 A             includes/KAutoSaveFile  
 M  +2 -0      kdecore/config/kconfig.h  
 M  +3 -0      kdecore/config/kconfigbackend.h  
 M  +3 -0      kdecore/config/kconfigbase.h  
 M  +2 -0      kdecore/config/kconfiggroup.h  
 M  +7 -0      kdecore/config/kcoreconfigskeleton.h  
 M  +2 -0      kdecore/config/kdesktopfile.h  
 M  +2 -0      kdecore/config/ksharedconfig.h  
 M  +2 -0      kdecore/io/kautosavefile.h  
 M  +2 -0      kdecore/io/klockfile.h  
 M  +2 -0      kdecore/io/kmessage.h  
 M  +2 -0      kdecore/io/kprocess.h  
 M  +2 -0      kdecore/io/ksavefile.h  
 M  +2 -0      kdecore/io/ktempdir.h  
 M  +2 -0      kdecore/io/ktemporaryfile.h  
 M  +4 -0      kdecore/io/kurl.h  
 M  +2 -0      kdecore/sycoca/kprotocolinfo.h  
 M  +2 -0      kdecore/util/kallocator.h  
 M  +2 -0      kdecore/util/kdedmodule.h  
 M  +4 -0      kdecore/util/kgenericfactory.h  
 M  +2 -0      kdecore/util/klibloader.h  
 M  +2 -0      kdecore/util/klibrary.h  
 M  +6 -0      kdecore/util/kmacroexpander.h  
 M  +2 -0      kdecore/util/kpluginfactory.h  
 M  +2 -0      kdecore/util/kpluginloader.h  
 M  +2 -0      kdecore/util/krandom.h  
 M  +2 -0      kdecore/util/krandomsequence.h  
 M  +2 -0      kdecore/util/ksharedptr.h  
 M  +4 -0      kdecore/util/ksortablelist.h  
 M  +4 -0      kdecore/util/kuser.h  


--- trunk/KDE/kdelibs/kdecore/config/kconfig.h #802810:802811
@@ -39,6 +39,8 @@
 class KConfigPrivate;
 
 /**
+ * \class KConfig kconfig.h <KConfig>
+ * 
  * \brief The central class of the KDE configuration data system.
  *
  * Quickstart:
--- trunk/KDE/kdelibs/kdecore/config/kconfigbackend.h #802810:802811
@@ -37,6 +37,9 @@
 class QByteArray;
 class QDateTime;
 
+/**
+ * \class KConfigBackend kconfigbackend.h <KConfigBackEnd>
+ */
 class KDECORE_EXPORT KConfigBackend : public QObject, public KShared
 {
     Q_OBJECT
--- trunk/KDE/kdelibs/kdecore/config/kconfigbase.h #802810:802811
@@ -32,6 +32,9 @@
 class KConfigGroup;
 class KConfigBasePrivate;
 
+/**
+ * \class KConfigBase kconfigbase.h <KConfigBase>
+ */
 class KDECORE_EXPORT KConfigBase
 {
 public:
--- trunk/KDE/kdelibs/kdecore/config/kconfiggroup.h #802810:802811
@@ -39,6 +39,8 @@
 typedef KSharedPtr<KSharedConfig> KSharedConfigPtr;
 
 /**
+ * \class KConfigGroup kconfiggroup.h <KConfigGroup>
+ * 
  * A class for one specific group in a KConfig object.
  * 
  * If you want to access the top-level entries of a KConfig
--- trunk/KDE/kdelibs/kdecore/config/kcoreconfigskeleton.h #802810:802811
@@ -37,6 +37,8 @@
 
   class KConfigSkeletonItemPrivate;
   /**
+   * \class KConfigSkeletonItem kcoreconfigskeleton.h <KConfigSkeletonItem>
+   * 
    * @short Class for storing a preferences setting
    * @author Cornelius Schumacher
    * @see KCoreConfigSkeleton
@@ -197,6 +199,9 @@
   };
 
 
+/**
+ * \class KConfigSkeletonGenericItem kcoreconfigskeleton.h \
<KConfigSkeletonGenericItem> + */
 template < typename T > class KConfigSkeletonGenericItem:public KConfigSkeletonItem
   {
   public:
@@ -288,6 +293,8 @@
   };
 
   /**
+   * \class KCoreConfigSkeleton kcoreconfigskeleton.h <KCoreConfigSkeleton>
+   * 
    * @short Class for handling preferences settings for an application.
    * @author Cornelius Schumacher
    * @see KConfigSkeletonItem
--- trunk/KDE/kdelibs/kdecore/config/kdesktopfile.h #802810:802811
@@ -25,6 +25,8 @@
 class KDesktopFilePrivate;
 
 /**
+ * \class KDesktopFile kdesktopfile.h <KDesktopFile>
+ * 
  * %KDE Desktop File Management.
  * This class implements %KDE's support for the freedesktop.org
  * <em>Desktop Entry Spec</em>.
--- trunk/KDE/kdelibs/kdecore/config/ksharedconfig.h #802810:802811
@@ -26,6 +26,8 @@
 #include <ksharedptr.h>
 
 /**
+ * \class KSharedConfig ksharedconfig.h <KSharedConfig>
+ * 
  * KConfig variant using shared memory
  *
  * KSharedConfig provides a reference counted, shared memory variant
--- trunk/KDE/kdelibs/kdecore/io/kautosavefile.h #802810:802811
@@ -28,6 +28,8 @@
 
 class KAutoSaveFilePrivate;
 /**
+ * \class KAutoSaveFile kautosavefile.h <KAutoSaveFile>
+ * 
  * @brief Creates and manages an "auto-save" file.
  * Autosave files are temporary files that applications use to store
  * the unsaved data in a file they have open for
--- trunk/KDE/kdelibs/kdecore/io/klockfile.h #802810:802811
@@ -27,6 +27,8 @@
 class QString;
 
 /**
+ * \class KLockFile klockfile.h <KLockFile>
+ * 
  * The KLockFile class provides NFS safe lockfiles.
  *
  * @author Waldo Bastian <bastian@kde.org>
--- trunk/KDE/kdelibs/kdecore/io/kmessage.h #802810:802811
@@ -100,6 +100,8 @@
 }
 
 /**
+ * \class KMessageHandler kmessage.h <KMessageHandler>
+ * 
  * @brief Abstract class for KMessage handler.
  * This class define how KMessage display a message.
  *
--- trunk/KDE/kdelibs/kdecore/io/kprocess.h #802810:802811
@@ -29,6 +29,8 @@
 class KProcessPrivate;
 
 /**
+ * \class KProcess kprocess.h <KProcess>
+ * 
  * Child process invocation, monitoring and control.
  *
  * This class extends QProcess by some useful functionality, overrides
--- trunk/KDE/kdelibs/kdecore/io/ksavefile.h #802810:802811
@@ -29,6 +29,8 @@
 #include <kglobal.h>
 
 /**
+ * \class KSaveFile ksavefile.h <KSaveFile>
+ *
  * @brief Class to allow for atomic file I/O, as well as utility functions.
  *
  * The KSaveFile class has been made to write out changes to an existing
--- trunk/KDE/kdelibs/kdecore/io/ktempdir.h #802810:802811
@@ -24,6 +24,8 @@
 #include <QtCore/QString>
 
 /**
+ * \class KTempDir ktempdir.h <KTempDir>
+ * 
  * @brief Create a unique directory for temporary use.
  *
  * The KTempDir class creates a unique directory for temporary use.
--- trunk/KDE/kdelibs/kdecore/io/ktemporaryfile.h #802810:802811
@@ -29,6 +29,8 @@
 class KTemporaryFilePrivate;
 
 /**
+ * \class KTemporaryFile ktemporaryfile.h <KTemporaryFile>
+ *
  * @brief A QTemporaryFile that will save in the KDE temp directory.
  *
  * This class derives from QTemporaryFile and makes sure that your temporary
--- trunk/KDE/kdelibs/kdecore/io/kurl.h #802810:802811
@@ -40,6 +40,8 @@
 // (DF)
 
 /**
+ * \class KUrl kurl.h <KUrl>
+ * 
  * Represents and parses a URL.
  *
  * A prototypical URL looks like:
@@ -113,6 +115,8 @@
   enum MimeDataFlags { DefaultMimeDataFlags = 0, NoTextExport = 1 };
 
   /**
+   * \class List kurl.h <KUrl>
+   * 
    * KUrl::List is a QList that contains KUrls with a few
    * convenience methods.
    * @see KUrl
--- trunk/KDE/kdelibs/kdecore/sycoca/kprotocolinfo.h #802810:802811
@@ -31,6 +31,8 @@
 class KProtocolInfoPrivate;
 
 /**
+ * \class KProtocolInfo kprotocolinfo.h <KProtocolInfo>
+ * 
  * Information about I/O (Internet, etc.) protocols supported by KDE.
 
  * This class is useful if you want to know which protocols
--- trunk/KDE/kdelibs/kdecore/util/kallocator.h #802810:802811
@@ -32,6 +32,8 @@
 
 
 /**
+ * \class KZoneAllocator kallocator.h <KZoneAllocator>
+ * 
  * Memory allocator for large groups of small objects.
  * This should be used for large groups of objects that are created and
  * destroyed together. When used carefully for this purpose it is faster
--- trunk/KDE/kdelibs/kdecore/util/kdedmodule.h #802810:802811
@@ -31,6 +31,8 @@
 class Kded;
 
 /**
+ * \class KDEDModule kdedmodule.h <KDEDModule>
+ * 
  * The base class for KDED modules.
  *
  * KDED modules are realized as shared
--- trunk/KDE/kdelibs/kdecore/util/kgenericfactory.h #802810:802811
@@ -166,6 +166,8 @@
 };
 
 /**
+ * \class KGenericFactory kgenericfactory.h <KGenericFactory>
+ * 
  * This template provides a generic implementation of a KLibFactory ,
  * for use with shared library components. It implements the pure virtual
  * createObject method of KLibFactory and instantiates objects of the
@@ -256,6 +258,8 @@
 };
 
 /**
+ * \class KGenericFactory kgenericfactory.h <KGenericFactory>
+ * 
  * This template provides a generic implementation of a KLibFactory ,
  * for use with shared library components. It implements the pure virtual
  * createObject method of KLibFactory and instantiates objects of the
--- trunk/KDE/kdelibs/kdecore/util/klibloader.h #802810:802811
@@ -34,6 +34,8 @@
     extern "C" { KDE_EXPORT KPluginFactory *init_##libname() { return new factory; } \
}  
 /**
+ * \class KLibLoader klibloader.h <KLibLoader>
+ * 
  * The KLibLoader allows you to load libraries dynamically at runtime.
  * Dependent libraries are loaded automatically.
  *
--- trunk/KDE/kdelibs/kdecore/util/klibrary.h #802810:802811
@@ -29,6 +29,8 @@
 class KPluginFactory;
 
 /**
+ * \class KLibrary klibrary.h <KLibrary>
+ * 
  * Thin wrapper around QLibrary; you should rarely use this directly, see \
                KPluginLoader for higher-level loading of plugins.
  * KLibrary adds kde3-factory and kde4-factory support to QLibrary (for the \
                deprecated KLibLoader)
  * KLibrary also searches libs in the kde search paths.
--- trunk/KDE/kdelibs/kdecore/util/kmacroexpander.h #802810:802811
@@ -31,6 +31,8 @@
 class KMacroExpanderBasePrivate;
 
 /**
+ * \class KMacroExpanderBase kmacroexpander.h <KMacroExpanderBase>
+ * 
  * Abstract base class for the worker classes behind the KMacroExpander namespace
  * and the KCharMacroExpander and KWordMacroExpander classes.
  *
@@ -163,6 +165,8 @@
 };
 
 /**
+ * \class KWordMacroExpander kmacroexpander.h <KMacroExpanderBase>
+ * 
  * Abstract base class for simple word macro substitutors. Use this instead of
  * the functions in the KMacroExpander namespace if speculatively pre-filling
  * the substitution map would be too expensive.
@@ -234,6 +238,8 @@
 };
 
 /**
+ * \class KCharMacroExpander kmacroexpander.h <KMacroExpanderBase>
+ * 
  * Abstract base class for single char macro substitutors. Use this instead of
  * the functions in the KMacroExpander namespace if speculatively pre-filling
  * the substitution map would be too expensive.
--- trunk/KDE/kdelibs/kdecore/util/kpluginfactory.h #802810:802811
@@ -156,6 +156,8 @@
 #define K_PLUGIN_FACTORY_DEFINITION(name, pluginRegistrations) \
K_PLUGIN_FACTORY_DEFINITION_WITH_BASEFACTORY(name, KPluginFactory, \
pluginRegistrations)  
 /**
+ * \class KPluginFactory kpluginfactory.h <KPluginFactory>
+ * 
  * If you develop a library that is to be loaded dynamically at runtime, then
  * you should return a pointer to a KPluginFactory.
  *
--- trunk/KDE/kdelibs/kdecore/util/kpluginloader.h #802810:802811
@@ -33,6 +33,8 @@
 class KPluginLoaderPrivate;
 
 /**
+ * \class KPluginLoader kpluginloader.h <KPluginLoader>
+ * 
  * This class can be used to dynamically load a plugin library at runtime.
  *
  * This class makes sure that the Qt and KDE versions used to compile this library \
                aren't newer then
--- trunk/KDE/kdelibs/kdecore/util/krandom.h #802810:802811
@@ -27,6 +27,8 @@
 #include <QtCore/QString>
 
 /**
+ * \headerfile krandom.h <KRandom>
+ * 
  * @short Helper class to create random data
  *
  * This namespace provides methods which generate random data.
--- trunk/KDE/kdelibs/kdecore/util/krandomsequence.h #802810:802811
@@ -22,6 +22,8 @@
 #include <QtCore/QList>
 
 /**
+ * \class KRandomSequence krandomsequence.h <KRandomSequence>
+ * 
  * A class to create a pseudo-random sequence
  *
  * Given a seed number, this class will produce a sequence of
--- trunk/KDE/kdelibs/kdecore/util/ksharedptr.h #802810:802811
@@ -34,6 +34,8 @@
 typedef QSharedData KShared;
 
 /**
+ * \class KSharedPtr ksharedptr.h <KSharedPtr>
+ * 
  * Can be used to control the lifetime of an object that has derived
  * QSharedData. As long a someone holds
  * a KSharedPtr on some QSharedData object it won't become deleted but
--- trunk/KDE/kdelibs/kdecore/util/ksortablelist.h #802810:802811
@@ -26,6 +26,8 @@
 #include <QtCore/QList>
 
 /**
+ * \class KSortableItem ksortablelist.h <KSortableItem>
+ * 
  * KSortableItem is a QPair that provides several operators
  * for sorting.
  * @see KSortableList
@@ -127,6 +129,8 @@
 
 
 /**
+ * \class KSortableList ksortablelist.h <KSortableList>
+ * 
  * KSortableList is a QList which associates a key with each item in the list.
  * This key is used for sorting when calling sort().
  *
--- trunk/KDE/kdelibs/kdecore/util/kuser.h #802810:802811
@@ -45,6 +45,8 @@
 
 
 /**
+ * \class KUser kuser.h <KUser>
+ * 
  * @short Represents a user on your system
  *
  * This class represents a user on your system. You can either get
@@ -244,6 +246,8 @@
 };
 
 /**
+ * \class KUserGroup kuser.h <KUserGroup>
+ * 
  * @short Represents a group on your system
  *
  * This class represents a group on your system. You can either get


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

Configure | About | News | Add a list | Sponsored by KoreLogic