summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/io
diff options
context:
space:
mode:
authorMichael Stahl <mstahl@redhat.com>2013-05-30 13:28:29 +0200
committerMichael Stahl <mstahl@redhat.com>2013-06-04 12:01:12 +0200
commitf9a606ecd39f59364e9b0a88d38775f07a31fb82 (patch)
tree530ed25780bcf3caedba134b64482b7332c4d15f /udkapi/com/sun/star/io
parenta95520b501751af8977cc47a40d1897023fb2b78 (diff)
*api: tweak docs
Change-Id: I20878a3977fe7b3ab7e733a7bc0d704fb5835009
Diffstat (limited to 'udkapi/com/sun/star/io')
-rw-r--r--udkapi/com/sun/star/io/DataInputStream.idl2
-rw-r--r--udkapi/com/sun/star/io/FilePermission.idl4
-rw-r--r--udkapi/com/sun/star/io/XInputStream.idl17
-rw-r--r--udkapi/com/sun/star/io/XPersistObject.idl10
4 files changed, 18 insertions, 15 deletions
diff --git a/udkapi/com/sun/star/io/DataInputStream.idl b/udkapi/com/sun/star/io/DataInputStream.idl
index 81b590d4f22a..923ce61d541e 100644
--- a/udkapi/com/sun/star/io/DataInputStream.idl
+++ b/udkapi/com/sun/star/io/DataInputStream.idl
@@ -47,7 +47,7 @@ published service DataInputStream
*/
interface com::sun::star::io::XActiveDataSink;
- /** Allows to chain the DataInputStream, so that
+ /** Allows to chain the DataInputStream.
*/
interface com::sun::star::io::XConnectable;
diff --git a/udkapi/com/sun/star/io/FilePermission.idl b/udkapi/com/sun/star/io/FilePermission.idl
index 2b498a01f597..d23d90a38bee 100644
--- a/udkapi/com/sun/star/io/FilePermission.idl
+++ b/udkapi/com/sun/star/io/FilePermission.idl
@@ -29,7 +29,7 @@ module com { module sun { module star { module io {
directories contained in that directory. A path that ends with <code>"/-"</code>
indicates (recursively) all files and subdirectories contained in that
directory. A file url string consisting of the special token
- <code>"&lt;&lt;ALL FILES&gt;&gt;"</code> matches any file.
+ <code>"<<ALL FILES>>"</code> matches any file.
<br>
Note: A file url string consisting of a single <code>"*"</code> indicates all the files
in the current directory, while a string consisting of a single <code>"-"</code> indicates
@@ -52,7 +52,7 @@ module com { module sun { module star { module io {
@attention
Be careful when granting FilePermissions. Think about the implications of
granting read and especially write access to various files and directories.
- The <code>"&lt;&lt;ALL FILES&gt;&gt;"</code> permission with write action is
+ The <code>"<<ALL FILES>>"</code> permission with write action is
especially dangerous. This grants permission to write to the entire file system.
@since OOo 1.1.2
diff --git a/udkapi/com/sun/star/io/XInputStream.idl b/udkapi/com/sun/star/io/XInputStream.idl
index 9e65585914e5..2a8d433868b6 100644
--- a/udkapi/com/sun/star/io/XInputStream.idl
+++ b/udkapi/com/sun/star/io/XInputStream.idl
@@ -43,11 +43,11 @@ published interface XInputStream: com::sun::star::uno::XInterface
and the return value indicates that EOF has been reached. This means
that the method blocks until the specified number of bytes are
available or the EOF is reached. </p>
- @param aData
+
+ @param aData
after the call, the byte sequence contains the requested number
of bytes (or less as a sign of EOF).
-
- <p>
+ <br>
C++ only : Note that for unbridged (e.g., in-process)
calls, using the same sequence for repetive readBytes()-calls
can bear a performance advantage. The callee can put the data
@@ -63,13 +63,14 @@ published interface XInputStream: com::sun::star::uno::XInterface
<li> the call is not bridged (e.g., betweeen different compilers
or different processes ).
</ol>
-
+ <br>
If the same 'optimized' code runs against an interface in a different process,
there is an unnecessary memory allocation/deallocation (the out parameter
is of course NOT transported over the connection), but this should
be negligible compared to a synchron call.
+
@param nBytesToRead
- the total number of bytes to read
+ the total number of bytes to read
*/
long readBytes( [out] sequence<byte> aData,
[in] long nBytesToRead )
@@ -87,6 +88,7 @@ published interface XInputStream: com::sun::star::uno::XInterface
returns 0 and the corresponding byte sequence is empty.
Otherwise, after the call, aData contains the available,
but no more than nMaxBytesToRead, bytes.
+
@param aData contains the data read from the stream.
@param nMaxBytesToRead The maximum number of bytes to be read from this
stream during the call.
@@ -102,8 +104,9 @@ published interface XInputStream: com::sun::star::uno::XInterface
<p>It is up to the implementation whether this method is
blocking the thread or not. </p>
- @param nBytesToSkip
- number of bytes to skip
+
+ @param nBytesToSkip
+ number of bytes to skip
*/
void skipBytes( [in] long nBytesToSkip )
raises( com::sun::star::io::NotConnectedException,
diff --git a/udkapi/com/sun/star/io/XPersistObject.idl b/udkapi/com/sun/star/io/XPersistObject.idl
index 2f6c8e06dc3b..3f39896edcab 100644
--- a/udkapi/com/sun/star/io/XPersistObject.idl
+++ b/udkapi/com/sun/star/io/XPersistObject.idl
@@ -56,14 +56,14 @@ published interface XPersistObject: com::sun::star::uno::XInterface
/** gives the service name of the object
- @returns
- the service name that specifies the behavior and the
- persistent data format of this implementation.
-
<p>This name is used to create such an object by a factory
during deserialization. </p>
- @see com::sun::star::lang::XServiceInfo::getAvailableServiceNames
+ @returns
+ the service name that specifies the behavior and the
+ persistent data format of this implementation.
+
+ @see com::sun::star::lang::XMultiComponentFactory::getAvailableServiceNames()
*/
string getServiceName();