apidox

svn path=/trunk/KDE/kdeedu/libkdeedu/; revision=705234

diff --git a/keduvocdocument/keduvocdocument.h b/keduvocdocument/keduvocdocument.h
index 4a227282a421b3fce8bda2b24abcd021b10b26b1..2c4d7596c93a86493053dee6140d6efbf22c94e0 100644 (file)
--- a/keduvocdocument/keduvocdocument.h
+++ b/keduvocdocument/keduvocdocument.h
@@ -350,7 +350,9 @@ public:
   void setUsageDescriptions(const QStringList &names);
 
   /**
-   * Gets the descriptions of the usages
+   * Gets the descriptions of the usages.
+   * Usages are context information in a dictionary you may find [biol.]
+   * [am.] and the like to hint at the context in which the word is usually used.
    */
   QStringList usageDescriptions() const;
 
@@ -606,6 +608,11 @@ public:
 
 Q_SIGNALS:
   void progressChanged (KEduVocDocument *, int curr_percent);
+
+  /**
+   * Emitted when the document becomes modified or saved.
+   * @returns state (true=modified)
+   */
   void docModified (bool mod);
 
 private: