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

List:       kde-commits
Subject:    branches/KDE/3.5/kdelibs/kdecore
From:       Adriaan de Groot <groot () kde ! org>
Date:       2005-08-03 0:01:13
Message-ID: 1123027273.764831.2986.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 442526 by adridg:

Dox completeness: document bits that weren't -- mostly protected or internal stuff, \
needed for other contributors to the code but not immediately useful for people \
looking at the public side of the API. 547 errors in kdecore left.

 M  +21 -0     kaccelbase.h  
 M  +1 -0      kmacroexpander.cpp  
 M  +11 -1     kmacroexpander.h  


--- branches/KDE/3.5/kdelibs/kdecore/kaccelbase.h #442525:442526
@@ -121,19 +121,40 @@
 class KDECORE_EXPORT KAccelBase
 {
  public:
+	/** Initialization mode of the KAccelBase, used in constructor. */
 	enum Init { QT_KEYS = 0x00, NATIVE_KEYS = 0x01 };
+
+	/** Enum for kinds of signals which may be emitted. */
 	enum Signal { KEYCODE_CHANGED };
 
+	/** Constructor. @p fInitCode should be a bitwise OR of
+	*   values from the Init enum.
+	*/
 	KAccelBase( int fInitCode );
 	virtual ~KAccelBase();
 
+	/** Returns number of actions in this handler. */
 	uint actionCount() const;
+	/** Returns a list of all the actions in this handler. */
 	KAccelActions& actions();
+	/** Returns whether this accelerator handler is enabled or not. */
 	bool isEnabled() const;
 
+	/** Returns a pointer to the KAccelAction named @p sAction. */
 	KAccelAction* actionPtr( const QString& sAction );
+	/** Const version of the above. */
 	const KAccelAction* actionPtr( const QString& sAction ) const;
+	/** Returns a pointer to the KAccelAction associated with
+	*   the key @p key. This function takes into account the
+	*   key mapping defined in the constructor.
+	*
+	*   May return 0 if no (or more than one)
+	*   action is associated with the key.
+	*/
 	KAccelAction* actionPtr( const KKey& key );
+	/** Basically the same as above, except a KKeyServer::Key
+	*   already has a key mapping defined (either NATIVE_KEYS or not).
+	*/
 	KAccelAction* actionPtr( const KKeyServer::Key& key );
 
 	const QString& configGroup() const { return m_sConfigGroup; }
--- branches/KDE/3.5/kdelibs/kdecore/kmacroexpander.cpp #442525:442526
@@ -81,6 +81,7 @@
 
 namespace KMacroExpander {
 
+    /** @intern Quoting state of the expander code. Not available publicly. */
     enum Quoting { noquote, singlequote, doublequote, dollarquote, 
                    paren, subst, group, math };
     typedef struct {
--- branches/KDE/3.5/kdelibs/kdecore/kmacroexpander.h #442525:442526
@@ -355,15 +355,25 @@
      * are simply join(" ")ed together.
      */
     KDECORE_EXPORT QString expandMacros( const QString &str, const \
QMap<QChar,QStringList> &map, QChar c = '%' ); +    /**
+     * Same as above, except that the macros expand to string lists that
+     * are simply join(" ")ed together.
+     */
     KDECORE_EXPORT QString expandMacros( const QString &str, const \
QMap<QString,QStringList> &map, QChar c = '%' );  
-    /*
+    /**
      * Same as above, except that the macros expand to string lists.
      * If the macro appears inside a quoted string, the list is simply
      * join(" ")ed together; otherwise every element expands to a separate
      * quoted string.
      */
     KDECORE_EXPORT QString expandMacrosShellQuote( const QString &str, const \
QMap<QChar,QStringList> &map, QChar c = '%' ); +    /**
+     * Same as above, except that the macros expand to string lists.
+     * If the macro appears inside a quoted string, the list is simply
+     * join(" ")ed together; otherwise every element expands to a separate
+     * quoted string.
+     */
     KDECORE_EXPORT QString expandMacrosShellQuote( const QString &str, const \
QMap<QString,QStringList> &map, QChar c = '%' );  }
 


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