sw: add doxygen comments for some document model / layout classes

5 files changed, 6 insertions, 1 deletions

diff --git a/sw/inc/doc.hxx b/sw/inc/doc.hxx
index 8fb1c1b376a6..580108ea30ae 100644
--- a/sw/inc/doc.hxx
+++ b/sw/inc/doc.hxx
@@ -249,6 +249,7 @@ void SetAllScriptItem( SfxItemSet& rSet, const SfxPoolItem& rItem );
 // global function to start grammar checking in the document
 void StartGrammarChecking( SwDoc &rDoc );
 
+/// Represents the model of a Writer document.
 class SW_DLLPUBLIC SwDoc :
     public IInterface,
     public IDocumentSettingAccess,
diff --git a/sw/inc/index.hxx b/sw/inc/index.hxx
index 329fcb4e4adf..8d183db8f243 100644
--- a/sw/inc/index.hxx
+++ b/sw/inc/index.hxx
@@ -48,6 +48,7 @@ struct SwPosition;
 #define INLINE inline
 #endif
 
+/// Marks a character position inside a document model node.
 class SW_DLLPUBLIC SwIndex
 {
 private:
diff --git a/sw/inc/ndindex.hxx b/sw/inc/ndindex.hxx
index 566d180cf91d..42834083c6af 100644
--- a/sw/inc/ndindex.hxx
+++ b/sw/inc/ndindex.hxx
@@ -38,6 +38,7 @@
 class SwNode;
 class SwNodes;
 
+/// Marks a node in the document model.
 class SW_DLLPUBLIC SwNodeIndex
 {
     friend void SwNodes::RegisterIndex( SwNodeIndex& );
diff --git a/sw/inc/ndtxt.hxx b/sw/inc/ndtxt.hxx
index b412aa43fadf..21e9fb4aa71e 100644
--- a/sw/inc/ndtxt.hxx
+++ b/sw/inc/ndtxt.hxx
@@ -79,7 +79,7 @@ namespace com { namespace sun { namespace star {
 
 typedef std::set< xub_StrLen > SwSoftPageBreakList;
 
-// SwTxtNode
+/// SwTxtNode is a paragraph in the document model.
 class SW_DLLPUBLIC SwTxtNode: public SwCntntNode, public ::sfx2::Metadatable
 {
 
diff --git a/sw/inc/pam.hxx b/sw/inc/pam.hxx
index 53d1486632ac..1ca3905bfd64 100644
--- a/sw/inc/pam.hxx
+++ b/sw/inc/pam.hxx
@@ -53,6 +53,7 @@ namespace utl {
     class TextSearch;
 }
 
+/// Marks a position in the document model.
 struct SW_DLLPUBLIC SwPosition
 {
     SwNodeIndex nNode;
@@ -157,6 +158,7 @@ extern SwGoInDoc fnGoCntntCellsSkipHidden;
 
 void _InitPam();
 
+/// PaM is Point and Mark: a selection of the document model.
 class SW_DLLPUBLIC SwPaM : public Ring
 {
     SwPosition   m_Bound1;