UPD: Updated documentation

Author: ThirtySomething

documentation/smcore/about.md

@@ -15,27 +15,26 @@ namespace smos
 {
     namespace smcore
     {
-        class SMCORE_EXPORT About
+        class About
         {
         public:
             /**
              * @brief Get the about text
              *
              * @return QString
              */
-            static QString getAbout(void);
+            static smos::smcore::SMSring getAbout(void);
         };
     }
 }
-
 ```
 
 ### Usage
 
 ```c++
 #include "about.h"
 
-QString about = smos::smcore::About::getAbout();
+smos::smcore::SMSring about = smos::smcore::About::getAbout();
 ```
 
 [smabout]: ./About%20SourceMonitor.png

documentation/smcore/license.md

@@ -13,26 +13,27 @@ namespace smos
 {
     namespace smcore
     {
-        class SMCORE_EXPORT License
+        class License
         {
         public:
             /**
              * @brief Get the license text
              *
-             * @return QString
+             * @return smos::smcore::SMSring
              */
-            static QString getLicense(void);
-        }
+            static smos::smcore::SMSring getLicense(void);
+        };
     }
 }
+
 ```
 
 ### Usage
 
 ```c++
 #include "license.h"
 
-QString license = smos::smcore::License::getLicense();
+smos::smcore::SMSring license = smos::smcore::License::getLicense();
 ```
 
 ## Possible issues

documentation/smcore/options.md

@@ -20,60 +20,50 @@ namespace smos
 {
     namespace smcore
     {
-        class SMCORE_EXPORT SMOptions
+        class Options
         {
         public:
             /**
              * @brief Default constructor
              *
              * @param optionsfile Name of options file
              */
-            SMOptions(QString optionsfile);
+            Options(smos::smcore::SMSring optionsfile);
 
             /**
              * @brief Default destructor
              *
              */
-            ~SMOptions(void);
-
-            /**
-             * @brief Load options from INI file
-             */
-            void optionsLoad(void);
-
-            /**
-             * @brief Save options to INI file
-             */
-            void optionsSave(void);
+            ~Options(void);
 
             /**
              * @brief Get the editor call with filename templated
              *
-             * @return QString
+             * @return smos::smcore::SMSring
              */
-            QString codeEditorGet(void);
+            smos::smcore::SMSring codeEditorGet(void);
 
             /**
              * @brief Get the editor call with filename templated
              *
-             * @return QString
+             * @param codeeditor smos::smcore::SMSring
              */
-            void codeEditorSet(QString codeeditor);
+            void codeEditorSet(smos::smcore::SMSring codeeditor);
 
             /**
              * @brief Get the absolute path to the logfile
              *
-             * @return QString The absolute path to the logfile
+             * @return smos::smcore::SMSring The absolute path to the logfile
              */
-            QString logfileNameGet(void);
+            smos::smcore::SMSring logfileNameGet(void);
 
             /**
              * @brief Set the name (and path) of the logfile
              *
              * @param logfileName Name (and path) of the logfile to use
              */
-            void logfileNameSet(QString logfileName);
-        }
+            void logfileNameSet(smos::smcore::SMSring logfileName);
+        };
     }
 }
 ```
@@ -85,7 +75,7 @@ namespace smos
 
 smos::smcore::SMSettings settings = smos::smcore::SMSettings("smos_core.ini");
 
-QString logfileOld = settings.logfileNameGet();
+smos::smcore::SMSring logfileOld = settings.logfileNameGet();
 settings.logfileNameSet("logfilenew.log");
 ```
 

documentation/smcore/readme.md

@@ -3,7 +3,9 @@
 - [About][doc_about]
 - [License][doc_license]
 - [Options][doc_options]
+- [SMString][doc_smstring]
 
 [doc_about]: ./about.md
 [doc_license]: ./license.md
 [doc_options]: ./options.md
+[doc_smstring]: ./smstring.md

documentation/smcore/smstring.md

@@ -0,0 +1,37 @@
+# The smstring object
+
+WTF?! There are so much possibilities for using strings in C++ - don't know how to do a wise decision for stalbe use. There are a few possibilities
+
+- std::string
+- std::wstring
+- [ICU][lib_icu]
+
+We have to keep always in mind that the source code could contain comments or variables in local languages. Imagine source code in Arabic (from right to left, from top to bottom), Chinese (from left to right, from top to bottom), Hebrew (from right to left, from top to bottom), Japanese (from right to left, from top to bottom) or Thai (from left to right, from top to bottom) - it will not be easy to deal with such source code.
+
+## Implementation
+
+This is a functionality of `smcore` and located in `smcore/smstring.*`.
+
+The decision of which kind of string handling is moved to the future. To enable the project for working a simple `typedef` on `std::string` is used as placeholder for the future implementation. Of course this is not safe for the future but better than nothing.
+
+### Public API
+
+```c++
+namespace smos
+{
+    namespace smcore
+    {
+        typedef std::string SMSring;
+    }
+}
+```
+
+### Usage
+
+```c++
+#include "smstring.h"
+
+smos::smcore::SMString message = "Hello world";
+```
+
+[lib_icu]: https://icu.unicode.org/design/cpp