diff options
| author | Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de> | 2016-09-21 14:27:26 +0000 |
|---|---|---|
| committer | Stephan Bergmann <sbergman@redhat.com> | 2016-09-21 14:42:14 +0000 |
| commit | d0ebd056868e96469ca1356a0a2f37c433456f75 (patch) | |
| tree | 2d8bdbe10bc5859d37c33585bb5a17ba810ff87e /offapi | |
| parent | 7c9150af57dfeecf4a0828d20238adc1ecaf18e3 (diff) | |
Add some missing documentation to idl files
Change-Id: Id5a3a6d4cc08f55cd7ff31614248ce203b2e4e8d
Reviewed-on: https://gerrit.libreoffice.org/29146
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
Tested-by: Stephan Bergmann <sbergman@redhat.com>
Diffstat (limited to 'offapi')
| -rw-r--r-- | offapi/com/sun/star/frame/TitleChangedEvent.idl | 4 | ||||
| -rw-r--r-- | offapi/com/sun/star/frame/XTitleChangeBroadcaster.idl | 6 | ||||
| -rw-r--r-- | offapi/com/sun/star/frame/XTitleChangeListener.idl | 4 | ||||
| -rw-r--r-- | offapi/com/sun/star/modules.idl | 4 |
4 files changed, 9 insertions, 9 deletions
diff --git a/offapi/com/sun/star/frame/TitleChangedEvent.idl b/offapi/com/sun/star/frame/TitleChangedEvent.idl index 0d924fd7202d..2005d946147b 100644 --- a/offapi/com/sun/star/frame/TitleChangedEvent.idl +++ b/offapi/com/sun/star/frame/TitleChangedEvent.idl @@ -24,11 +24,11 @@ module com { module sun { module star { module frame { -/** todo document me +/** Contains the information about a changed title. */ struct TitleChangedEvent : com::sun::star::lang::EventObject { - /** todo document me + /** The new title */ string Title; }; diff --git a/offapi/com/sun/star/frame/XTitleChangeBroadcaster.idl b/offapi/com/sun/star/frame/XTitleChangeBroadcaster.idl index e8121f07ba12..bd53e1aa41f6 100644 --- a/offapi/com/sun/star/frame/XTitleChangeBroadcaster.idl +++ b/offapi/com/sun/star/frame/XTitleChangeBroadcaster.idl @@ -25,15 +25,15 @@ module com { module sun { module star { module frame { -/** todo document me +/** Allows to register for title changed events. */ interface XTitleChangeBroadcaster : com::sun::star::uno::XInterface { - /** todo document me + /** Add a listener */ void addTitleChangeListener ( [in] com::sun::star::frame::XTitleChangeListener xListener ); - /** todo document me + /** Remove a listener */ void removeTitleChangeListener ( [in] com::sun::star::frame::XTitleChangeListener xListener ); }; diff --git a/offapi/com/sun/star/frame/XTitleChangeListener.idl b/offapi/com/sun/star/frame/XTitleChangeListener.idl index 2584ab418741..4c8a27d2b113 100644 --- a/offapi/com/sun/star/frame/XTitleChangeListener.idl +++ b/offapi/com/sun/star/frame/XTitleChangeListener.idl @@ -25,11 +25,11 @@ module com { module sun { module star { module frame { -/** todo document me +/** Allows to receive notifications when the frame title changes */ interface XTitleChangeListener : com::sun::star::lang::XEventListener { - /** todo document me + /** The frame title has changed */ void titleChanged ( [in] TitleChangedEvent aEvent ); }; diff --git a/offapi/com/sun/star/modules.idl b/offapi/com/sun/star/modules.idl index 5a5427b81b10..0adbcf58ff09 100644 --- a/offapi/com/sun/star/modules.idl +++ b/offapi/com/sun/star/modules.idl @@ -103,7 +103,7 @@ module configuration { }; -/// TODO: what is this? +/// Common user interface elements module cui {}; /// Clipboard and Drag&Drop interfaces. @@ -338,7 +338,7 @@ module sdbcx {}; /// cryptographic interfaces. module security {}; -/// TODO: what is this? +/// Setup specific interfaces module setup {}; /// Spreadsheet specific interfaces. |