docs

1 files changed, 10 insertions, 0 deletions

diff --git a/libopie2/opiecore/oglobal.h b/libopie2/opiecore/oglobal.h
index 5b43f01..aeee75e 100644
--- a/libopie2/opiecore/oglobal.h
+++ b/libopie2/opiecore/oglobal.h
@@ -36,97 +36,107 @@
 #ifndef private
 #define HACK_DEFINED
 #define private protected
 #endif
 #include <qpe/global.h>
 #ifdef HACK_DEFINED
 #undef private
 #endif
 
 #include <sys/types.h>
 
 //FIXME Is it wise or even necessary to inherit OGlobal from Global?
 //      once we totally skip libqpe it should ideally swallow Global -zecke
 //      You're right. I deleted global as the base class. -mickeyl
 
 
 class QFile;
 class QString;
 class DateFormat;
 /**
  *\brief OGlobal contains a list of generic functions
  *
  * The class OGlobal contains small utility functions
  * which might be useful for other applications to use. It features access
  * to the global device config and specialized functions to get information
  * out of this config like Weekstart or Owner name.
  *
  * @todo ODP implement the things from Global which are good
  * @author mickey,alwin,zecke
  * @version 0.1
  */
 class OGlobal : public Global
 {
 public:
 
     //  how do they relate to our Document Idea
     /** @name Document System related functions
      *
      */
     //@{
     static bool isAppLnkFileName( const QString& str );
     static bool isDocumentFileName( const QString& file );
     //@}
 
     /** @name File Operations
      *  File operations provided by OGlobal
      */
     //@{
+    /** the content of TEMP
+     * reads the environment variable TEMP and returns the content. 
+     * if not set returns "/tmp"
+     * @return a string containing a dir without trailing slash!
+     */
     static QString tempDirPath();
+    /** the content of HOME
+     * reads the environment variable HOME and returns the content. 
+     * if not set returns "/"
+     * @return a string containing a dir without trailing slash!
+     */
     static QString homeDirPath();
     static QString tempFileName( const QString& );
     static bool renameFile( const QString& from, const QString& to );
     static bool truncateFile( QFile &f, off_t size );
     //@}
 
 
     static QString generateUuid();
 
     /** @name Convert Content
      * Convert Content of a QByteArray
      */
     //@{
     static QByteArray encodeBase64(const QByteArray&, bool insertLF = false );
     static QByteArray decodeBase64(const QByteArray& );
     //@}
 
     //FIXME Do we want to put that into OApplication as in KApplication? -zecke
     //      We already have a per-application config in OApplication
     //      ( accessed through oApp->config() ), but this one is the global one! -mickeyl
     /** @name Config and Owner related Information
      *
      */
     //@{
     static OConfig* config();
     static OConfig* qpe_config();
     static QString ownerName();
     static bool weekStartsOnMonday();
     static bool useAMPM();
 #ifdef ODP
 #error "Fix dateFormat"
    /**
     * For Qt3/Qt4 we can use QDate::toString(OGlobal::dateFormat)
     * See if we need to use the function with String in it
     * Anyway this is the future
     * for now still use TimeString!
     */
 #endif
     static DateFormat dateFormat();
     static void setDateFormat( const DateFormat& );
 
 
     static void setWeekStartsOnMonday( bool );
     static void setUseAMPM( bool );
     //@}
 
    //@{
     static Global::Command* builtinCommands();