sidebar uno api corrections

Change-Id: I1bd1040cc80c0450a5e029c37f0737c0692c056a
Reviewed-on: https://gerrit.libreoffice.org/17952
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
Tested-by: Stephan Bergmann <sbergman@redhat.com>

7 files changed, 28 insertions, 10 deletions

diff --git a/offapi/UnoApi_offapi.mk b/offapi/UnoApi_offapi.mk
index 0a915f43c917..505f4f540292 100644
--- a/offapi/UnoApi_offapi.mk
+++ b/offapi/UnoApi_offapi.mk
@@ -4013,17 +4013,17 @@ $(eval $(call gb_UnoApi_add_idlfiles,offapi,com/sun/star/ui,\
 	XContextChangeEventMultiplexer \
 	XContextMenuInterception \
 	XContextMenuInterceptor \
+	XDeck \
+	XDecks \
 	XDockingAreaAcceptor \
 	XImageManager \
 	XModuleUIConfigurationManager \
 	XModuleUIConfigurationManager2 \
 	XModuleUIConfigurationManagerSupplier \
-	XSidebar \
-	XSidebarPanel \
 	XPanel \
 	XPanels \
-	XDeck \
-	XDecks \
+	XSidebar \
+	XSidebarPanel \
 	XSidebarProvider \
 	XStatusbarItem \
 	XToolPanel \
@@ -4036,7 +4036,7 @@ $(eval $(call gb_UnoApi_add_idlfiles,offapi,com/sun/star/ui,\
 	XUIConfigurationStorage \
 	XUIElement \
 	XUIElementFactory \
-    XUIElementFactoryManager \
+	XUIElementFactoryManager \
 	XUIElementFactoryRegistration \
 	XUIElementSettings \
 	XUpdateModel \
diff --git a/offapi/com/sun/star/frame/XController2.idl b/offapi/com/sun/star/frame/XController2.idl
index 400b7aea68da..23c64f1a1e89 100644
--- a/offapi/com/sun/star/frame/XController2.idl
+++ b/offapi/com/sun/star/frame/XController2.idl
@@ -63,6 +63,7 @@ interface XController2 : XController
                                                             CreationArguments;
 
     /** get the sidebar if exists
+        @since LibreOffice 5.1
     */
     ::com::sun::star::ui::XSidebarProvider getSidebar();
 };
diff --git a/offapi/com/sun/star/ui/XDeck.idl b/offapi/com/sun/star/ui/XDeck.idl
index 53b739703587..f19ed40dc9e3 100644
--- a/offapi/com/sun/star/ui/XDeck.idl
+++ b/offapi/com/sun/star/ui/XDeck.idl
@@ -15,7 +15,9 @@
 
  module com {  module sun {  module star {  module ui {
 
-/** provides access to Desk */
+/** provides access to Deck
+    @since LibreOffice 5.1
+*/
 
 interface XDeck
 
@@ -39,7 +41,7 @@ interface XDeck
     */
     boolean isActive();
 
-    /** Activate the deck and isplays its content
+    /** Activate the deck and displays its content
 
         @param bActivate
             The requested state for the deck
diff --git a/offapi/com/sun/star/ui/XDecks.idl b/offapi/com/sun/star/ui/XDecks.idl
index ba7c3a7f3107..0ed297702db6 100644
--- a/offapi/com/sun/star/ui/XDecks.idl
+++ b/offapi/com/sun/star/ui/XDecks.idl
@@ -15,11 +15,16 @@
 
  module com {  module sun {  module star {  module ui {
 
-/** provides access to Desks of a Sidebar.*/
+/** provides access to Decks of a Sidebar.
+    @since LibreOffice 5.1
+*/
 
 interface XDecks
 
 {
+    /**
+        returned ANYs are actually of type com::sun::star::ui::XDeck
+    */
     interface com::sun::star::container::XIndexAccess;
     interface com::sun::star::container::XNameAccess;
 };
diff --git a/offapi/com/sun/star/ui/XPanel.idl b/offapi/com/sun/star/ui/XPanel.idl
index 0070d2356cca..f02d8b3b5609 100644
--- a/offapi/com/sun/star/ui/XPanel.idl
+++ b/offapi/com/sun/star/ui/XPanel.idl
@@ -16,7 +16,9 @@
 
  module com {  module sun {  module star {  module ui {
 
-/** provides access to Desk */
+/** provides access to Panel
+    @since LibreOffice 5.1
+*/
 
 interface XPanel
 
diff --git a/offapi/com/sun/star/ui/XPanels.idl b/offapi/com/sun/star/ui/XPanels.idl
index a2aa85103e46..361785546f41 100644
--- a/offapi/com/sun/star/ui/XPanels.idl
+++ b/offapi/com/sun/star/ui/XPanels.idl
@@ -15,14 +15,21 @@
 
  module com {  module sun {  module star {  module ui {
 
-/** provides access to Panels of a Deck.*/
+/** provides access to Panels of a Deck.
+    @since LibreOffice 5.1
+*/
 
 interface XPanels
 
 {
+    /**
+        returned ANYs are actually of type com::sun::star::ui::XPanel
+    */
     interface com::sun::star::container::XIndexAccess;
     interface com::sun::star::container::XNameAccess;
 
+    /** The deck Id that contains the Panels
+    */
     string getDeckId();
 };
 
diff --git a/offapi/com/sun/star/ui/XSidebarProvider.idl b/offapi/com/sun/star/ui/XSidebarProvider.idl
index 8392bea6255a..96dbfd8dce1a 100644
--- a/offapi/com/sun/star/ui/XSidebarProvider.idl
+++ b/offapi/com/sun/star/ui/XSidebarProvider.idl
@@ -21,6 +21,7 @@
 module com { module sun { module star { module ui {
 
 /** Interface of the sidebar
+    @since LibreOffice 5.1
 */
 interface XSidebarProvider: com::sun::star::uno::XInterface
 {