[Libreoffice-commits] .: sw/inc sw/source

[Miklos Vajna]

 sw/inc/format.hxx            |    1 +
 sw/inc/frmfmt.hxx            |    1 +
 sw/inc/node.hxx              |   12 +++---------
 sw/source/core/inc/frame.hxx |    7 +++++++
 4 files changed, 12 insertions(+), 9 deletions(-)

New commits:
commit 06fa03d6ca0e27468129bfffaacecfd491738309
Author: Miklos Vajna <vmiklos at suse.cz>
Date:   Fri Feb 17 10:47:49 2012 +0100

    sw: second round of doxygen comments

diff --git a/sw/inc/format.hxx b/sw/inc/format.hxx
index 660a7fe..28b4fac 100644
--- a/sw/inc/format.hxx
+++ b/sw/inc/format.hxx
@@ -42,6 +42,7 @@ class IDocumentFieldsAccess;
 class IDocumentChartDataProviderAccess;
 class SwDoc;
 
+/// Base class for various Writer styles.
 class SW_DLLPUBLIC SwFmt : public SwModify
 {
     String aFmtName;
diff --git a/sw/inc/frmfmt.hxx b/sw/inc/frmfmt.hxx
index e06dea9..d0be16d 100644
--- a/sw/inc/frmfmt.hxx
+++ b/sw/inc/frmfmt.hxx
@@ -44,6 +44,7 @@ class SwRect;
 class SwContact;
 class SdrObject;
 
+/// Style of a layout element.
 class SW_DLLPUBLIC SwFrmFmt: public SwFmt
 {
     friend class SwDoc;
diff --git a/sw/inc/node.hxx b/sw/inc/node.hxx
index f75091a..fa2736c 100644
--- a/sw/inc/node.hxx
+++ b/sw/inc/node.hxx
@@ -85,9 +85,7 @@ class IDocumentContentOperations;
 class IDocumentListItems;
 class SwOLENodes;
 
-// --------------------
-// class SwNode
-// --------------------
+/// Base class of the Writer document model elements.
 class SW_DLLPUBLIC SwNode
     : private BigPtrEntry
 {
@@ -304,9 +302,7 @@ private:
     SwNode & operator= ( const SwNode & rNodes );
 };
 
-// --------------------
-// class SwStartNode
-// --------------------
+/// Starts a section of nodes in the document model.
 class SwStartNode: public SwNode
 {
     friend class SwNode;
@@ -340,9 +336,7 @@ private:
 };
 
 
-// --------------------
-// class SwEndNode
-// --------------------
+/// Ends a section of nodes in the document model.
 class SwEndNode : public SwNode
 {
     friend class SwNodes;
diff --git a/sw/source/core/inc/frame.hxx b/sw/source/core/inc/frame.hxx
index 7e4a389..e61ee3f 100644
--- a/sw/source/core/inc/frame.hxx
+++ b/sw/source/core/inc/frame.hxx
@@ -250,6 +250,13 @@ enum MakePageType
 };
 
 
+/**
+ * Base class of the Writer layout elements.
+ *
+ * This includes not only fly frames, but everything down to the paragraph
+ * level: pages, headers, footers, etc. (Inside a paragraph SwLinePortion
+ * instances are used.)
+ */
 class SwFrm: public SwClient, public SfxBroadcaster
 {
     //Der verkappte Frm