Changeset 56 for trunk/src/IDocument.h

Timestamp:

04/14/06 06:50:46 (3 years ago)

Author:

jordi

Message:

Added the documentation comments for PageMode? and PageLayout?.

Files:

• trunk/src/IDocument.h (modified) (1 diff)

trunk/src/IDocument.h

@@ -61 +61 @@
         
     ///
-    /// @brief Defines the document's page mode.
+    /// @brief Defines the document's page mode when opened.
     ///
     typedef enum 
     {
+        /// Document outline visible.
         PageModeOutlines,
+        /// Thumbnail images visible.
         PageModeThumbs,
+        /// Full-screen mode, with no menu bar, window controls or any
+        /// other window visible.
         PageModeFullScreen,
+        /// Optional content group panel visible.
         PageModeOC,
+        /// Attachments panel visible.
         PageModeAttach,
-        /// Not set yet.
+        /// Not set and neither outline nor thumbnail images visible.
         PageModeUnset
     } PageMode;
 
     ///
-    /// @brief Defines the document's page layout.
+    /// @brief Defines the document's page layout when opened.
     ///
     typedef enum
     {
+        /// Display one page at a time.
         PageLayoutSinglePage,
+        /// Display the pages on one column.
         PageLayoutOneColumn,
+        /// Display the pages in two columns, with odd-numbered pages
+        /// on the left.
         PageLayoutTwoColumnLeft,
+        /// Display the pages in two columns, with odd-numbered pages
+        /// on the right.
         PageLayoutTwoColumnRight,
+        /// Display the pages two at a time, with odd-numbered pages
+        /// on the left.
         PageLayoutTwoPageLeft,
+        /// Display the pages two at a time, with odd-numbered pages
+        /// on the right.
         PageLayoutTwoPageRight,
-        // Not set yet.
+        /// The page layout was not set yet.
         PageLayoutUnset
     } PageLayout;