Some cosmetics in l10ntools

Add comment to new classes
Delete unneeded getLanguage() method
Make inline GenPoEntry's setter methods
Fix some typo

Change-Id: I8f337b8c57e1eab7696415dc7297c64e2436f35d

3 files changed, 31 insertions, 4 deletions

diff --git a/l10ntools/inc/po.hxx b/l10ntools/inc/po.hxx
index 856c7bb04ff1..ace9e09e3643 100644
--- a/l10ntools/inc/po.hxx
+++ b/l10ntools/inc/po.hxx
@@ -18,6 +18,16 @@ class PoOfstream;
 class PoIfstream;
 class GenPoEntry;
 
+
+/** Interface to use po entries in localization
+
+    PoEntry based on GenPoEntry class which stores attributes
+    of general po entry(see po.cxx). It makes easy to get/set
+    all information needed to localize one english(US) string.
+    It contains some basic checkings and some string
+    transformations between po string and string used by
+    localization tools.
+*/
 class PoEntry
 {
 private:
@@ -61,6 +71,12 @@ public:
 
 };
 
+/** Interface to work with header of po/pot files
+
+    This class stores informations which are in header of
+    a po file. It's main function to generate header to
+    template po files(pot).
+*/
 class PoHeader: private boost::noncopyable
 {
 private:
@@ -73,16 +89,14 @@ public:
     friend class PoOfstream;
     friend class PoIfstream;
 
-    enum Exception { NOLANG };
-
                     PoHeader();
                     PoHeader( const OString& rExtSrc );
                     PoHeader( std::ifstream& rOldPo );
                     ~PoHeader();
-
-    OString         getLanguage() const;
 };
 
+/** Interface to write po entry to files as output streams
+*/
 class PoOfstream: private boost::noncopyable
 {
 private:
@@ -101,6 +115,8 @@ public:
     void    writeEntry(const PoEntry& rPo);
 };
 
+/** Interface to read po entry from files as input streams
+*/
 class PoIfstream: private boost::noncopyable
 {
 private:
diff --git a/l10ntools/inc/propmerge.hxx b/l10ntools/inc/propmerge.hxx
index 4f0e3275a434..a44649cfb91b 100644
--- a/l10ntools/inc/propmerge.hxx
+++ b/l10ntools/inc/propmerge.hxx
@@ -13,6 +13,11 @@
 #include <rtl/string.hxx>
 #include <vector>
 
+/** Class for properties localization
+
+    Parse *.properties files, extract translatable strings
+    and merge translated strings.
+*/
 class PropParser
 {
 private:
diff --git a/l10ntools/inc/treemerge.hxx b/l10ntools/inc/treemerge.hxx
index 3b681126bfab..98f5a0218c1a 100644
--- a/l10ntools/inc/treemerge.hxx
+++ b/l10ntools/inc/treemerge.hxx
@@ -14,6 +14,12 @@
 #include <rtl/string.hxx>
 #include <vector>
 
+/** Class for tree localization
+
+    Parse *.tree files, extract translatable strings,
+    merge translated strings and update reference and title
+    of referred help files.
+*/
 class TreeParser
 {
 private: