Changeset 720 for code/branches/FICN/src/orxonox/core/Language.h

Timestamp:

Dec 29, 2007, 2:37:45 AM (16 years ago)

Author:

landauf

Message:

documented and commented the Language.h and .cc file

File:

• code/branches/FICN/src/orxonox/core/Language.h (modified) (5 diffs)

code/branches/FICN/src/orxonox/core/Language.h

@@ -26 +26 @@
  */
 
+/*!
+    @file Language.h
+    @brief Definition of the Language and the LanguageEntry class.
+
+    The Language class is used, to get a translation of a string in the configured language.
+    The string is identified by another string, the name of the entry.
+    If the translation in the configured language isn't available, the default entry, defined in the code, is used.
+
+    Usage:
+     - Set the entry with the default string:
+       Language::getLanguage()->addEntry("name of the entry", "the string to translate");
+
+     - Get the translation of the entry in the configured language:
+       std::cout << Language::getLanguage()->getTranslation("name of the entry") << std::endl;
+*/
+
 #ifndef _Language_H__
 #define _Language_H__
@@ -33 +49 @@
 
 #include "CorePrereqs.h"
-
 #include "OrxonoxClass.h"
 
@@ -40 +55 @@
     typedef std::string LanguageEntryName;
 
+    //! The LanguageEntry class stores the default- and the translated string of a given entry in the language file.
     class _CoreExport LanguageEntry : public OrxonoxClass
     {
@@ -47 +63 @@
             void setDefault(const std::string& fallbackEntry);
 
+            /** @brief Returns the translated entry in the configured language. @return The translated entry */
             inline const std::string& getTranslation()
                 { return this->translatedEntry_; }
 
+            /** @brief Returns the default entry. @return The default entry */
             inline const std::string& getDefault()
                 { return this->fallbackEntry_; }
 
         private:
-            std::string fallbackEntry_;
-            std::string translatedEntry_;
+            std::string fallbackEntry_;                             //!< The default entry: Used, if no translation is available or no language configured
+            std::string translatedEntry_;                           //!< The translated entry in the configured language
     };
 
+    //! The Language class manges the language files and entries and stores the LanguageEntry objects in a map.
     class _CoreExport Language : public OrxonoxClass
     {
@@ -77 +96 @@
             void createEntry(const LanguageEntryName& name, const std::string& entry);
 
-            std::string language_;
-            std::string defaultLanguage_;
-            std::string defaultTranslation_;
-            std::map<std::string, LanguageEntry*> languageEntries_;
+            std::string language_;                                  //!< The configured language
+            std::string defaultLanguage_;                           //!< The default language
+            std::string defaultTranslation_;                        //!< The returned string, if an entry unavailable entry is requested
+            std::map<std::string, LanguageEntry*> languageEntries_; //!< A map to store all LanguageEntry objects and their name
     };
 }