From 75946e42e3fad483db8b91ee42b0c0dbd1cf3c63 Mon Sep 17 00:00:00 2001
From: Pino Toscano <pino@kde.org>
Date: Sat, 20 Jan 2007 14:51:43 +0000
Subject: [PATCH] DOX: improvements and fixes SVN_SILENT

svn path=/trunk/playground/graphics/okular/; revision=625599
---
 core/annotations.h     |  2 --
 core/bookmarkmanager.h |  6 ++++++
 core/generator.h       | 20 +++++++++++++++-----
 core/page.h            |  7 +++++--
 core/sound.h           |  2 +-
 5 files changed, 27 insertions(+), 10 deletions(-)

diff --git a/core/annotations.h b/core/annotations.h
index a072b9c1e..d48bc2f53 100644
--- a/core/annotations.h
+++ b/core/annotations.h
@@ -183,8 +183,6 @@ class OKULAR_EXPORT Annotation
 
         /**
          * Sets the unique @p name of the annotation.
-         *
-         * The unique name should have the form 'okular-#NUMBER#'
          */
         void setUniqueName( const QString &name );
 
diff --git a/core/bookmarkmanager.h b/core/bookmarkmanager.h
index 61671006f..0f1a278c0 100644
--- a/core/bookmarkmanager.h
+++ b/core/bookmarkmanager.h
@@ -22,6 +22,12 @@ namespace Okular {
 class Document;
 class DocumentViewport;
 
+/**
+ * @brief Bookmarks manager utility.
+ *
+ * This class is responsible for loading and saving the bookmarks using the
+ * proper format, and for working with them (eg querying, adding, removing).
+ */
 class OKULAR_EXPORT BookmarkManager : public QObject
 {
     Q_OBJECT
diff --git a/core/generator.h b/core/generator.h
index e171f14a9..937ab229b 100644
--- a/core/generator.h
+++ b/core/generator.h
@@ -126,18 +126,28 @@ class OKULAR_EXPORT ExportFormat
 /**
  * @short [Abstract Class] The information generator.
  *
- * Most of class members are pure virtuals and they must be implemented to
- * provide a class that builds contents (graphics and text).
+ * Most of class members are virtuals and some of them pure virtual. The pure
+ * virtuals provide the minimal functionalities for a Generator, that is being
+ * able to generate QPixmap for the Page 's of the Document.
  *
- * Generation/query is requested by the 'Document' class only, and that
- * class stores the resulting data into 'Page's. The data will then be
- * displayed by the GUI components (pageView, thumbnailList, etc..).
+ * Implementing the other functions will make the Generator able to provide
+ * more contents and/or functionalities (like text extraction).
+ *
+ * Generation/query is requested by the Document class only, and that
+ * class stores the resulting data into Page s. The data will then be
+ * displayed by the GUI components (PageView, ThumbnailList, etc..).
+ *
+ * @see PrintInterface, ConfigInterface, GuiInterface
  */
 class OKULAR_EXPORT Generator : public QObject
 {
     Q_OBJECT
 
     public:
+        /**
+         * Describe the possible optional features that a Generator can
+         * provide.
+         */
         enum GeneratorFeature
         {
             TextExtraction,    ///< Whether the Generator can extract text from the document in the form of TextPage's
diff --git a/core/page.h b/core/page.h
index c687efea1..b0003fe21 100644
--- a/core/page.h
+++ b/core/page.h
@@ -49,10 +49,13 @@ class OKULAR_EXPORT Page : public QObject
     Q_OBJECT
 
     public:
+        /**
+         * An action to be executed when particular events happen.
+         */
         enum PageAction
         {
-            Opening,
-            Closing
+            Opening,       ///< An action to be executed when the page is "opened".
+            Closing        ///< An action to be executed when the page is "closed".
         };
 
         /**
diff --git a/core/sound.h b/core/sound.h
index d16c42ef5..79ef772be 100644
--- a/core/sound.h
+++ b/core/sound.h
@@ -40,7 +40,7 @@ class OKULAR_EXPORT Sound
         enum SoundEncoding {
             Raw,         ///< Is not encoded
             Signed,      ///< Is encoded with twos-complement values
-            muLaw,       ///< Is µ-law encoded
+            muLaw,       ///< Is µ-law encoded
             ALaw         ///< Is A-law encoded
         };