diff options
author | Fritz Elfert <felfert@to.com> | 2001-02-02 11:17:03 +0000 |
---|---|---|
committer | Fritz Elfert <felfert@to.com> | 2001-02-02 11:17:03 +0000 |
commit | 1664530e8f0e1ac6e762a1c79629fcec86f68724 (patch) | |
tree | 42ba46ae0c92d99871929ac28cd9db1d3a7b544f | |
parent | f1840173ca21b3668c25b3fdec73f9bbcbb8cb12 (diff) | |
download | plptools-1664530e8f0e1ac6e762a1c79629fcec86f68724.tar.gz plptools-1664530e8f0e1ac6e762a1c79629fcec86f68724.tar.bz2 plptools-1664530e8f0e1ac6e762a1c79629fcec86f68724.zip |
Added some KDOC API documentation.
-rw-r--r-- | lib/plpdirent.h | 4 | ||||
-rw-r--r-- | lib/psitime.h | 24 | ||||
-rw-r--r-- | lib/rfsv.h | 2 |
3 files changed, 27 insertions, 3 deletions
diff --git a/lib/plpdirent.h b/lib/plpdirent.h index d10c76a..ab1f3a4 100644 --- a/lib/plpdirent.h +++ b/lib/plpdirent.h @@ -2,8 +2,8 @@ #define _PLP_DIRENT_H_ #include <string> -#include <psitime.h> -#include <rfsv.h> +#include "psitime.h" +#include "rfsv.h" class PlpUID { diff --git a/lib/psitime.h b/lib/psitime.h index 74d05af..0650cda 100644 --- a/lib/psitime.h +++ b/lib/psitime.h @@ -93,6 +93,8 @@ typedef struct psi_timezone_t { * fallback uses the local machine's setup, which assumes * that both Psion and local machine have the same * time zone and daylight settings. + * + * @author Fritz Elfert <felfert@to.com> */ class PsiTime { public: @@ -261,12 +263,34 @@ private: bool ptzValid; }; +/** + * A singleton wrapper for a @ref psi_timezone . This class is used + * by @ref PsiTime to initialize it's psi_timezone variable. + * PsiZone itself is initialized from within @ref rpcs::getMachineInfo . + * In an application, you typically call this at the very beginning, just + * after connection setup. From then on, a single PsiZone instance is + * held in memory and used by the various constructors of PsiTime. + * + * @author Fritz Elfert <felfert@to.com> + */ class PsiZone { friend class rpcs32; public: + /** + * Retrieve the singleton object. + * If it does not exist, it is created. + */ static PsiZone &getInstance(); + /** + * Retrieve the Psion's time zone. + * + * @param ptz The time zone is returned here. + * + * @returns false, if the time zone is not + * known (yet). + */ bool getZone(psi_timezone &ptz); private: @@ -496,7 +496,7 @@ class rfsv { /** * Close a directory, previously opened with @ref opendir. * - * @param handle A handle, obtained by calling @see opendir. + * @param handle A handle, obtained by calling @ref opendir . * * @returns A Psion error code (One of enum @ref #errs ). */ |