summaryrefslogtreecommitdiff
path: root/store
diff options
context:
space:
mode:
authorJuergen Schmidt <jsc@openoffice.org>2001-05-28 13:56:04 +0000
committerJuergen Schmidt <jsc@openoffice.org>2001-05-28 13:56:04 +0000
commit175d851bae203afdf63bd67a1cc0f69f9af45667 (patch)
treef75f142a4c57fed392f0ad179b6bba94ebdae1fa /store
parentdd048dfcd07b52bcd57591c490708e27dfb2b344 (diff)
#87190# removing leading * in documentation
Diffstat (limited to 'store')
-rw-r--r--store/inc/store/filelckb.hxx58
-rw-r--r--store/inc/store/lockbyte.hxx52
-rw-r--r--store/inc/store/memlckb.hxx52
-rw-r--r--store/inc/store/store.h222
-rw-r--r--store/inc/store/types.h36
5 files changed, 210 insertions, 210 deletions
diff --git a/store/inc/store/filelckb.hxx b/store/inc/store/filelckb.hxx
index 26bcd3c97..ab36a200d 100644
--- a/store/inc/store/filelckb.hxx
+++ b/store/inc/store/filelckb.hxx
@@ -2,9 +2,9 @@
*
* $RCSfile: filelckb.hxx,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: mhu $ $Date: 2001-03-13 20:37:59 $
+ * last change: $Author: jsc $ $Date: 2001-05-28 14:56:04 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -60,7 +60,7 @@
************************************************************************/
#ifndef _STORE_FILELCKB_HXX_
-#define _STORE_FILELCKB_HXX_ "$Revision: 1.2 $"
+#define _STORE_FILELCKB_HXX_ "$Revision: 1.3 $"
#ifndef _SAL_TYPES_H_
#include <sal/types.h>
@@ -100,20 +100,20 @@ public:
OFileLockBytes (void);
/** create.
- * @param pFilename [in]
- * @param eAccessMode [in]
- * @return store_E_None upon success
+ @param pFilename [in]
+ @param eAccessMode [in]
+ @return store_E_None upon success
*/
storeError create (
rtl_uString *pFilename,
storeAccessMode eAccessMode);
/** Read at Offset into Buffer.
- * @param nOffset [in]
- * @param pBuffer [out]
- * @param nBytes [in]
- * @param rnDone [out]
- * @return store_E_None upon success
+ @param nOffset [in]
+ @param pBuffer [out]
+ @param nBytes [in]
+ @param rnDone [out]
+ @return store_E_None upon success
*/
virtual storeError readAt (
sal_uInt32 nOffset,
@@ -122,11 +122,11 @@ public:
sal_uInt32 &rnDone);
/** Write at Offset from Buffer.
- * @param nOffset [in]
- * @param pBuffer [in]
- * @param nBytes [in]
- * @param rnDone [out]
- * @return store_E_None upon success
+ @param nOffset [in]
+ @param pBuffer [in]
+ @param nBytes [in]
+ @param rnDone [out]
+ @return store_E_None upon success
*/
virtual storeError writeAt (
sal_uInt32 nOffset,
@@ -135,37 +135,37 @@ public:
sal_uInt32 &rnDone);
/** flush.
- * @return store_E_None upon success
+ @return store_E_None upon success
*/
virtual storeError flush (void);
/** setSize.
- * @param nSize [in]
- * @return store_E_None upon success
+ @param nSize [in]
+ @return store_E_None upon success
*/
virtual storeError setSize (sal_uInt32 nSize);
/** stat.
- * @param rnSize [out]
- * @return store_E_None upon success
+ @param rnSize [out]
+ @return store_E_None upon success
*/
virtual storeError stat (sal_uInt32 &rnSize);
/** Lock range at Offset.
- * @param nOffset [in]
- * @param nBytes [in]
- * @return store_E_None upon success
- * store_E_LockingViolation
+ @param nOffset [in]
+ @param nBytes [in]
+ @return store_E_None upon success
+ store_E_LockingViolation
*/
virtual storeError lockRange (
sal_uInt32 nOffset,
sal_uInt32 nBytes);
/** Unlock range at Offset.
- * @param nOffset [in]
- * @param nBytes [in]
- * @return store_E_None upon success
- * store_E_LockingViolation
+ @param nOffset [in]
+ @param nBytes [in]
+ @return store_E_None upon success
+ store_E_LockingViolation
*/
virtual storeError unlockRange (
sal_uInt32 nOffset,
diff --git a/store/inc/store/lockbyte.hxx b/store/inc/store/lockbyte.hxx
index cf84bd03c..72796d16e 100644
--- a/store/inc/store/lockbyte.hxx
+++ b/store/inc/store/lockbyte.hxx
@@ -2,9 +2,9 @@
*
* $RCSfile: lockbyte.hxx,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: mhu $ $Date: 2001-03-13 20:37:59 $
+ * last change: $Author: jsc $ $Date: 2001-05-28 14:56:04 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -60,7 +60,7 @@
************************************************************************/
#ifndef _STORE_LOCKBYTE_HXX_
-#define _STORE_LOCKBYTE_HXX_ "$Revision: 1.2 $"
+#define _STORE_LOCKBYTE_HXX_ "$Revision: 1.3 $"
#ifndef _SAL_TYPES_H_
#include <sal/types.h>
@@ -86,11 +86,11 @@ class ILockBytes : public rtl::IReference
{
public:
/**
- * @param nOffset [in]
- * @param pBuffer [out]
- * @param nBytes [in]
- * @param rnDone [out]
- * @return store_E_None upon success
+ @param nOffset [in]
+ @param pBuffer [out]
+ @param nBytes [in]
+ @param rnDone [out]
+ @return store_E_None upon success
*/
virtual storeError readAt (
sal_uInt32 nOffset,
@@ -99,11 +99,11 @@ public:
sal_uInt32 &rnDone) = 0;
/**
- * @param nOffset [in]
- * @param pBuffer [in]
- * @param nBytes [in]
- * @param rnDone [out]
- * @return store_E_None upon success
+ @param nOffset [in]
+ @param pBuffer [in]
+ @param nBytes [in]
+ @param rnDone [out]
+ @return store_E_None upon success
*/
virtual storeError writeAt (
sal_uInt32 nOffset,
@@ -112,37 +112,37 @@ public:
sal_uInt32 &rnDone) = 0;
/**
- * @return store_E_None upon success
+ @return store_E_None upon success
*/
virtual storeError flush (void) = 0;
/**
- * @param nSize [in]
- * @return store_E_None upon success
+ @param nSize [in]
+ @return store_E_None upon success
*/
virtual storeError setSize (sal_uInt32 nSize) = 0;
/**
- * @param rnSize [out]
- * @return store_E_None upon success
+ @param rnSize [out]
+ @return store_E_None upon success
*/
virtual storeError stat (sal_uInt32 &rnSize) = 0;
/**
- * @param nOffset [in]
- * @param nBytes [in]
- * @return store_E_None upon success
- * store_E_LockingViolation
+ @param nOffset [in]
+ @param nBytes [in]
+ @return store_E_None upon success
+ store_E_LockingViolation
*/
virtual storeError lockRange (
sal_uInt32 nOffset,
sal_uInt32 nBytes) = 0;
/**
- * @param nOffset [in]
- * @param nBytes [in]
- * @return store_E_None upon success
- * store_E_LockingViolation
+ @param nOffset [in]
+ @param nBytes [in]
+ @return store_E_None upon success
+ store_E_LockingViolation
*/
virtual storeError unlockRange (
sal_uInt32 nOffset,
diff --git a/store/inc/store/memlckb.hxx b/store/inc/store/memlckb.hxx
index 573dd3356..0800594a1 100644
--- a/store/inc/store/memlckb.hxx
+++ b/store/inc/store/memlckb.hxx
@@ -2,9 +2,9 @@
*
* $RCSfile: memlckb.hxx,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: mhu $ $Date: 2001-03-13 20:37:59 $
+ * last change: $Author: jsc $ $Date: 2001-05-28 14:56:04 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -60,7 +60,7 @@
************************************************************************/
#ifndef _STORE_MEMLCKB_HXX_
-#define _STORE_MEMLCKB_HXX_ "$Revision: 1.2 $"
+#define _STORE_MEMLCKB_HXX_ "$Revision: 1.3 $"
#ifndef _SAL_TYPES_H_
#include <sal/types.h>
@@ -97,11 +97,11 @@ public:
OMemoryLockBytes (void);
/** Read at Offset into Buffer.
- * @param nOffset [in]
- * @param pBuffer [out]
- * @param nBytes [in]
- * @param rnDone [out]
- * @return store_E_None upon success
+ @param nOffset [in]
+ @param pBuffer [out]
+ @param nBytes [in]
+ @param rnDone [out]
+ @return store_E_None upon success
*/
virtual storeError readAt (
sal_uInt32 nOffset,
@@ -110,11 +110,11 @@ public:
sal_uInt32 &rnDone);
/** Write at Offset from Buffer.
- * @param nOffset [in]
- * @param pBuffer [in]
- * @param nBytes [in]
- * @param rnDone [out]
- * @return store_E_None upon success
+ @param nOffset [in]
+ @param pBuffer [in]
+ @param nBytes [in]
+ @param rnDone [out]
+ @return store_E_None upon success
*/
virtual storeError writeAt (
sal_uInt32 nOffset,
@@ -123,37 +123,37 @@ public:
sal_uInt32 &rnDone);
/** flush.
- * @return store_E_None upon success
+ @return store_E_None upon success
*/
virtual storeError flush (void);
/** setSize.
- * @param nSize [in]
- * @return store_E_None upon success
+ @param nSize [in]
+ @return store_E_None upon success
*/
virtual storeError setSize (sal_uInt32 nSize);
/** stat.
- * @param rnSize [out]
- * @return store_E_None upon success
+ @param rnSize [out]
+ @return store_E_None upon success
*/
virtual storeError stat (sal_uInt32 &rnSize);
/** Lock range at Offset.
- * @param nOffset [in]
- * @param nBytes [in]
- * @return store_E_None upon success
- * store_E_LockingViolation
+ @param nOffset [in]
+ @param nBytes [in]
+ @return store_E_None upon success
+ store_E_LockingViolation
*/
virtual storeError lockRange (
sal_uInt32 nOffset,
sal_uInt32 nBytes);
/** Unlock range at Offset.
- * @param nOffset [in]
- * @param nBytes [in]
- * @return store_E_None upon success
- * store_E_LockingViolation
+ @param nOffset [in]
+ @param nBytes [in]
+ @return store_E_None upon success
+ store_E_LockingViolation
*/
virtual storeError unlockRange (
sal_uInt32 nOffset,
diff --git a/store/inc/store/store.h b/store/inc/store/store.h
index 5bd17a77e..87fdf9079 100644
--- a/store/inc/store/store.h
+++ b/store/inc/store/store.h
@@ -2,9 +2,9 @@
*
* $RCSfile: store.h,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: mhu $ $Date: 2001-03-13 20:26:37 $
+ * last change: $Author: jsc $ $Date: 2001-05-28 14:56:04 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -60,7 +60,7 @@
************************************************************************/
#ifndef _STORE_STORE_H_
-#define _STORE_STORE_H_ "$Revision: 1.2 $"
+#define _STORE_STORE_H_ "$Revision: 1.3 $"
#ifndef _STORE_TYPES_H_
#include <store/types.h>
@@ -75,17 +75,17 @@ extern "C" {
typedef void* storeHandle;
/** store_acquireHandle.
- * @param Handle [in]
- * @return store_E_None upon success
+ @param Handle [in]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_acquireHandle (
storeHandle Handle
) SAL_THROW_EXTERN_C();
/** store_releaseHandle.
- * @param Handle [in]
- * @return store_E_None upon success,
- * store_E_InvalidHandle otherwise.
+ @param Handle [in]
+ @return store_E_None upon success,
+ store_E_InvalidHandle otherwise.
*/
storeError SAL_CALL store_releaseHandle (
storeHandle Handle
@@ -97,10 +97,10 @@ storeError SAL_CALL store_releaseHandle (
typedef void* storeFileHandle;
/** store_createMemoryFile.
- * @param nPageSize [in] the creation page size,
- * integer multiple of minimum page size.
- * @param phFile [out]
- * @return store_E_None upon success
+ @param nPageSize [in] the creation page size,
+ integer multiple of minimum page size.
+ @param phFile [out]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_createMemoryFile (
sal_uInt16 nPageSize,
@@ -108,16 +108,16 @@ storeError SAL_CALL store_createMemoryFile (
) SAL_THROW_EXTERN_C();
/** store_openFile.
- * @param pFilename [in] the filename in host syntax.
- * @param eAccessMode [in] the access mode.
- * store_AccessCreate truncate existing and create,
- * store_AccessReadCreate create not existing,
- * store_AccessReadWrite write existing,
- * store_AccessReadOnly never modifies.
- * @param nPageSize [in] the creation page size,
- * integer multiple of minimum page size.
- * @param phFile [out]
- * @return store_E_None upon success
+ @param pFilename [in] the filename in host syntax.
+ @param eAccessMode [in] the access mode.
+ store_AccessCreate truncate existing and create,
+ store_AccessReadCreate create not existing,
+ store_AccessReadWrite write existing,
+ store_AccessReadOnly never modifies.
+ @param nPageSize [in] the creation page size,
+ integer multiple of minimum page size.
+ @param phFile [out]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_openFile (
rtl_uString *pFilename,
@@ -127,26 +127,26 @@ storeError SAL_CALL store_openFile (
) SAL_THROW_EXTERN_C();
/** store_closeFile.
- * @param hFile [in]
- * @return store_E_None upon success,
- * store_E_InvalidHandle otherwise.
+ @param hFile [in]
+ @return store_E_None upon success,
+ store_E_InvalidHandle otherwise.
*/
storeError SAL_CALL store_closeFile (
storeFileHandle hFile
) SAL_THROW_EXTERN_C();
/** store_flushFile.
- * @param hFile [in]
- * @return store_E_None upon success
+ @param hFile [in]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_flushFile (
storeFileHandle hFile
) SAL_THROW_EXTERN_C();
/** store_getFileRefererCount.
- * @param hFile [in]
- * @param pnRefCount [out] number of open directories and streams.
- * @return store_E_None upon success
+ @param hFile [in]
+ @param pnRefCount [out] number of open directories and streams.
+ @return store_E_None upon success
*/
storeError SAL_CALL store_getFileRefererCount (
storeFileHandle hFile,
@@ -154,9 +154,9 @@ storeError SAL_CALL store_getFileRefererCount (
) SAL_THROW_EXTERN_C();
/** store_getFileSize.
- * @param hFile [in]
- * @param pnSize [out]
- * @return store_E_None upon success
+ @param hFile [in]
+ @param pnSize [out]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_getFileSize (
storeFileHandle hFile,
@@ -164,9 +164,9 @@ storeError SAL_CALL store_getFileSize (
) SAL_THROW_EXTERN_C();
/** store_rebuildFile.
- * @param pSrcFilename [in] opened with store_AccessReadOnly.
- * @param pDstFilename [in] created with store_AccessCreate.
- * @return store_E_None upon success
+ @param pSrcFilename [in] opened with store_AccessReadOnly.
+ @param pDstFilename [in] created with store_AccessCreate.
+ @return store_E_None upon success
*/
storeError SAL_CALL store_rebuildFile (
rtl_uString *pSrcFilename,
@@ -179,12 +179,12 @@ storeError SAL_CALL store_rebuildFile (
typedef void* storeDirectoryHandle;
/** store_openDirectory.
- * @param hFile [in]
- * @param pPath [in]
- * @param pName [in]
- * @param eAccessMode [in]
- * @param phDirectory [out]
- * @return store_E_None upon success
+ @param hFile [in]
+ @param pPath [in]
+ @param pName [in]
+ @param eAccessMode [in]
+ @param phDirectory [out]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_openDirectory (
storeFileHandle hFile,
@@ -195,19 +195,19 @@ storeError SAL_CALL store_openDirectory (
) SAL_THROW_EXTERN_C();
/** store_closeDirectory.
- * @param hDirectory [in]
- * @return store_E_None upon success,
- * store_E_InvalidHandle otherwise.
+ @param hDirectory [in]
+ @return store_E_None upon success,
+ store_E_InvalidHandle otherwise.
*/
storeError SAL_CALL store_closeDirectory (
storeDirectoryHandle hDirectory
) SAL_THROW_EXTERN_C();
/** store_findFirst.
- * @param hDirectory [in]
- * @param pFindData [out]
- * @return store_E_None upon success,
- * store_E_NoMoreFile upon end of iteration.
+ @param hDirectory [in]
+ @param pFindData [out]
+ @return store_E_None upon success,
+ store_E_NoMoreFile upon end of iteration.
*/
storeError SAL_CALL store_findFirst (
storeDirectoryHandle hDirectory,
@@ -215,10 +215,10 @@ storeError SAL_CALL store_findFirst (
) SAL_THROW_EXTERN_C();
/** store_findNext.
- * @param hDirectory [in]
- * @param pFindData [out]
- * @return store_E_None upon success,
- * store_E_NoMoreFile upon end of iteration.
+ @param hDirectory [in]
+ @param pFindData [out]
+ @return store_E_None upon success,
+ store_E_NoMoreFile upon end of iteration.
*/
storeError SAL_CALL store_findNext (
storeDirectoryHandle hDirectory,
@@ -231,12 +231,12 @@ storeError SAL_CALL store_findNext (
typedef void* storeStreamHandle;
/** store_openStream.
- * @param hFile [in]
- * @param pPath [in]
- * @param pName [in]
- * @param eAccessMode [in]
- * @param phStrm [out]
- * @return store_E_None upon success
+ @param hFile [in]
+ @param pPath [in]
+ @param pName [in]
+ @param eAccessMode [in]
+ @param phStrm [out]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_openStream (
storeFileHandle hFile,
@@ -247,21 +247,21 @@ storeError SAL_CALL store_openStream (
) SAL_THROW_EXTERN_C();
/** store_closeStream.
- * @param hStrm [in]
- * @return store_E_None upon success,
- * store_E_InvalidHandle otherwise.
+ @param hStrm [in]
+ @return store_E_None upon success,
+ store_E_InvalidHandle otherwise.
*/
storeError SAL_CALL store_closeStream (
storeStreamHandle hStrm
) SAL_THROW_EXTERN_C();
/** store_readStream.
- * @param hStrm [in]
- * @param nOffset [in]
- * @param pBuffer [out]
- * @param nBytes [in]
- * @param pnDone [out]
- * @return store_E_None upon success
+ @param hStrm [in]
+ @param nOffset [in]
+ @param pBuffer [out]
+ @param nBytes [in]
+ @param pnDone [out]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_readStream (
storeStreamHandle hStrm,
@@ -272,12 +272,12 @@ storeError SAL_CALL store_readStream (
) SAL_THROW_EXTERN_C();
/** store_writeStream.
- * @param hStrm [in]
- * @param nOffset [in]
- * @param pBuffer [in]
- * @param nBytes [in]
- * @param pnDone [out]
- * @return store_E_None upon success
+ @param hStrm [in]
+ @param nOffset [in]
+ @param pBuffer [in]
+ @param nBytes [in]
+ @param pnDone [out]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_writeStream (
storeStreamHandle hStrm,
@@ -288,17 +288,17 @@ storeError SAL_CALL store_writeStream (
) SAL_THROW_EXTERN_C();
/** store_flushStream.
- * @param hStrm [in]
- * @return store_E_None upon success
+ @param hStrm [in]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_flushStream (
storeStreamHandle hStrm
) SAL_THROW_EXTERN_C();
/** store_getStreamSize.
- * @param hStrm [in]
- * @param pnSize [out]
- * @return store_E_None upon success
+ @param hStrm [in]
+ @param pnSize [out]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_getStreamSize (
storeStreamHandle hStrm,
@@ -306,9 +306,9 @@ storeError SAL_CALL store_getStreamSize (
) SAL_THROW_EXTERN_C();
/** store_setStreamSize.
- * @param hStrm [in]
- * @param nSize [in]
- * @return store_E_None upon success
+ @param hStrm [in]
+ @param nSize [in]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_setStreamSize (
storeStreamHandle hStrm,
@@ -316,13 +316,13 @@ storeError SAL_CALL store_setStreamSize (
) SAL_THROW_EXTERN_C();
/** store_attrib.
- * @param hFile [in]
- * @param pPath [in]
- * @param pName [in]
- * @param nMask1 [in]
- * @param nMask2 [in]
- * @param pnAttrib [out] may be NULL.
- * @return store_E_None upon success
+ @param hFile [in]
+ @param pPath [in]
+ @param pName [in]
+ @param nMask1 [in]
+ @param nMask2 [in]
+ @param pnAttrib [out] may be NULL.
+ @return store_E_None upon success
*/
storeError SAL_CALL store_attrib (
storeFileHandle hFile,
@@ -334,12 +334,12 @@ storeError SAL_CALL store_attrib (
) SAL_THROW_EXTERN_C();
/** store_link.
- * @param hFile [in]
- * @param pSrcPath [in]
- * @param pSrcName [in]
- * @param pDstPath [in]
- * @param pDstName [in]
- * @return store_E_None upon success
+ @param hFile [in]
+ @param pSrcPath [in]
+ @param pSrcName [in]
+ @param pDstPath [in]
+ @param pDstName [in]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_link (
storeFileHandle hFile,
@@ -348,12 +348,12 @@ storeError SAL_CALL store_link (
) SAL_THROW_EXTERN_C();
/** store_symlink.
- * @param hFile [in]
- * @param pSrcPath [in]
- * @param pSrcName [in]
- * @param pDstPath [in]
- * @param pDstName [in]
- * @return store_E_None upon success
+ @param hFile [in]
+ @param pSrcPath [in]
+ @param pSrcName [in]
+ @param pDstPath [in]
+ @param pDstName [in]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_symlink (
storeFileHandle hFile,
@@ -362,12 +362,12 @@ storeError SAL_CALL store_symlink (
) SAL_THROW_EXTERN_C();
/** store_rename.
- * @param hFile [in]
- * @param pSrcPath [in]
- * @param pSrcName [in]
- * @param pDstPath [in]
- * @param pDstName [in]
- * @return store_E_None upon success
+ @param hFile [in]
+ @param pSrcPath [in]
+ @param pSrcName [in]
+ @param pDstPath [in]
+ @param pDstName [in]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_rename (
storeFileHandle hFile,
@@ -376,10 +376,10 @@ storeError SAL_CALL store_rename (
) SAL_THROW_EXTERN_C();
/** store_remove.
- * @param hFile [in]
- * @param pPath [in]
- * @param pName [in]
- * @return store_E_None upon success
+ @param hFile [in]
+ @param pPath [in]
+ @param pName [in]
+ @return store_E_None upon success
*/
storeError SAL_CALL store_remove (
storeFileHandle hFile,
diff --git a/store/inc/store/types.h b/store/inc/store/types.h
index e521c225f..f007e2ed3 100644
--- a/store/inc/store/types.h
+++ b/store/inc/store/types.h
@@ -2,9 +2,9 @@
*
* $RCSfile: types.h,v $
*
- * $Revision: 1.2 $
+ * $Revision: 1.3 $
*
- * last change: $Author: mhu $ $Date: 2001-03-13 20:26:37 $
+ * last change: $Author: jsc $ $Date: 2001-05-28 14:56:04 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -60,7 +60,7 @@
************************************************************************/
#ifndef _STORE_TYPES_H_
-#define _STORE_TYPES_H_ "$Revision: 1.2 $"
+#define _STORE_TYPES_H_ "$Revision: 1.3 $"
#ifndef _SAL_TYPES_H_
#include <sal/types.h>
@@ -75,27 +75,27 @@ extern "C" {
#endif
/** PageSize (recommended) default.
- * @see store_openFile().
+ @see store_openFile().
*/
#define STORE_DEFAULT_PAGESIZE ((sal_uInt16)0x0400)
/** PageSize (enforced) limits.
- * @see store_openFile().
+ @see store_openFile().
*/
#define STORE_MINIMUM_PAGESIZE ((sal_uInt16)0x0200)
#define STORE_MAXIMUM_PAGESIZE ((sal_uInt16)0x8000)
/** NameSize (enforced) limit.
- * @see any param pName.
- * @see store_E_NameTooLong
+ @see any param pName.
+ @see store_E_NameTooLong
*/
#define STORE_MAXIMUM_NAMESIZE 256
/** Attributes (predefined).
- * @see store_attrib().
+ @see store_attrib().
*/
#define STORE_ATTRIB_ISLINK 0x10000000UL
#define STORE_ATTRIB_ISDIR 0x20000000UL
@@ -103,9 +103,9 @@ extern "C" {
/** storeAccessMode.
- * @see store_openFile().
- * @see store_openDirectory().
- * @see store_openStream().
+ @see store_openFile().
+ @see store_openDirectory().
+ @see store_openStream().
*/
typedef enum
{
@@ -148,29 +148,29 @@ typedef enum
/** storeFindData.
- * @see store_findFirst().
- * @see store_findNext().
+ @see store_findFirst().
+ @see store_findNext().
*/
typedef struct
{
/** Name.
- * @see m_nLength.
+ @see m_nLength.
*/
sal_Unicode m_pszName[STORE_MAXIMUM_NAMESIZE];
/** Name Length.
- * @see m_pszName.
+ @see m_pszName.
*/
sal_Int32 m_nLength;
/** Attributes.
- * @see store_attrib().
+ @see store_attrib().
*/
sal_uInt32 m_nAttrib;
/** Size.
- * @see store_getStreamSize().
- * @see store_setStreamSize().
+ @see store_getStreamSize().
+ @see store_setStreamSize().
*/
sal_uInt32 m_nSize;