DOX: improvements and fixes

SVN_SILENT

svn path=/trunk/playground/graphics/okular/; revision=625599

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 );
 

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

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
+ * Most of class members are virtuals and some of them pure virtual. The pure
- * provide a class that builds contents (graphics and text).
+ * 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
+ * Implementing the other functions will make the Generator able to provide
- * class stores the resulting data into 'Page's. The data will then be
+ * more contents and/or functionalities (like text extraction).
- * displayed by the GUI components (pageView, thumbnailList, etc..).
+ *
+ * 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

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,
+            Opening,       ///< An action to be executed when the page is "opened".
-            Closing
+            Closing        ///< An action to be executed when the page is "closed".
         };
 
         /**

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
         };