summaryrefslogtreecommitdiff
path: root/sw
diff options
context:
space:
mode:
authorMiklos Vajna <vmiklos@suse.cz>2012-02-17 10:47:49 +0100
committerMiklos Vajna <vmiklos@suse.cz>2012-02-17 10:49:01 +0100
commit06fa03d6ca0e27468129bfffaacecfd491738309 (patch)
tree527580490e00f1c073abd1e83b542f78d29cf022 /sw
parent243fbda523cb71d0919539081d286eec4717ce15 (diff)
sw: second round of doxygen comments
Diffstat (limited to 'sw')
-rw-r--r--sw/inc/format.hxx1
-rw-r--r--sw/inc/frmfmt.hxx1
-rw-r--r--sw/inc/node.hxx12
-rw-r--r--sw/source/core/inc/frame.hxx7
4 files changed, 12 insertions, 9 deletions
diff --git a/sw/inc/format.hxx b/sw/inc/format.hxx
index 660a7fe653e8..28b4facb981e 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 e06dea97ab54..d0be16da0cd7 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 f75091ab0684..fa2736cdcc19 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 7e4a389007f1..e61ee3f1e95c 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