API documentation added

1 files changed, 30 insertions, 15 deletions

diff --git a/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl b/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl
index 0edae8c0a127..5747174de09a 100644
--- a/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl
+++ b/offapi/com/sun/star/linguistic2/DictionaryListEvent.idl
@@ -2,9 +2,9 @@
  *
  *  $RCSfile: DictionaryListEvent.idl,v $
  *
- *  $Revision: 1.3 $
+ *  $Revision: 1.4 $
  *
- *  last change: $Author: mi $ $Date: 2000-11-08 12:43:23 $
+ *  last change: $Author: tl $ $Date: 2000-12-04 14:15:31 $
  *
  *  The Contents of this file are made available subject to the terms of
  *  either of the following licenses
@@ -75,32 +75,47 @@
 module com { module sun { module star { module linguistic2 {
 
 //=============================================================================
-/** This structure represents a dictionary-list event.
+/** structure representing a dictionary-list event.
 
-    @see    XDictionaryListEventListener
-    @see    EventObject
+    <P>This structure is used by the dictionary-list to inform
+    it's listeners about certain events.
+    Since the dictionary-list
+    is able to collect several single events before broadcasting
+    an to it's listeners the interger argument may be a
+    combination of several event types.
+    If more specific information about the events is requested by a
+    listener a sequence of all dictionary-list events since the
+    last broadcasting will be supplied. Otherwise that list will
+    be empty.</P>
+
+     @see   com::sun::star::linguistic2::XDictionaryList
+    @see    com::sun::star::linguistic2::XDictionaryListEventListener
+    @see    com::sun::star::lang::EventObject
 */
 struct DictionaryListEvent : com::sun::star::lang::EventObject
 {
     //-------------------------------------------------------------------------
-    /** The type of the occured Events.
+    /** the combined type of the accumulated events.
 
-        <P>It can be the combination of multiple
+        <p>The value can be the combination of multiple
          <type scope="com::sun::star::linguistic2">DictionaryListEventFlags</type>
-         by building the logical OR of them.</P>
+         by applying the logical OR to them.</p>
 
-        @see    DictionaryListEventFlags
-        @see    XDictionaryList
+        @see    com::sun::star::linguistic2::DictionaryListEventFlags
     */
     short nCondensedEvent;
 
     //-------------------------------------------------------------------------
-    /** A list of events.
-     ** It may be empty if all <type>XDictionaryListEventListener</type>
-     ** are satisfied with the the condensed representation of the above
-     ** member.
+    /** list of accumulated dictionary events.
+
+         <p>It will be empty if all
+         <type scope="com::sun::star::linguistic2::">
+         XDictionaryListEventListener</type>
+         are satisfied with the the condensed representation of the
+         <member scope="com::sun::star::linguistic2">
+         DictionaryListEvent::nCondensedEvent</member>.</p>
 
-        @see    XDictionaryList
+        @see    com::sun::star::linguistic2::DictionaryEvent
     */
     sequence< com::sun::star::linguistic2::DictionaryEvent > aDictionaryEvents;