[Libreoffice-commits] core.git: offapi/com
Samuel Mehrbrodt
Samuel.Mehrbrodt at cib.de
Wed Sep 21 14:43:58 UTC 2016
offapi/com/sun/star/frame/TitleChangedEvent.idl | 4 ++--
offapi/com/sun/star/frame/XTitleChangeBroadcaster.idl | 6 +++---
offapi/com/sun/star/frame/XTitleChangeListener.idl | 4 ++--
offapi/com/sun/star/modules.idl | 4 ++--
4 files changed, 9 insertions(+), 9 deletions(-)
New commits:
commit d0ebd056868e96469ca1356a0a2f37c433456f75
Author: Samuel Mehrbrodt <Samuel.Mehrbrodt at cib.de>
Date: Wed Sep 21 14:27:26 2016 +0000
Add some missing documentation to idl files
Change-Id: Id5a3a6d4cc08f55cd7ff31614248ce203b2e4e8d
Reviewed-on: https://gerrit.libreoffice.org/29146
Reviewed-by: Stephan Bergmann <sbergman at redhat.com>
Tested-by: Stephan Bergmann <sbergman at redhat.com>
diff --git a/offapi/com/sun/star/frame/TitleChangedEvent.idl b/offapi/com/sun/star/frame/TitleChangedEvent.idl
index 0d924fd..2005d94 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 e8121f0..bd53e1a 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 2584ab4..4c8a27d 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 5a5427b..0adbcf5 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.
More information about the Libreoffice-commits
mailing list