[Libreoffice-commits] core.git: offapi/com

[Tomaž Vajngerl]

 offapi/com/sun/star/document/XGraphicStorageHandler.idl |   19 +++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

New commits:
commit 90cb743a69ad4b7cb3466b7ce5b2bbed6353d792
Author: Tomaž Vajngerl <tomaz.vajngerl at collabora.co.uk>
Date:   Wed Mar 14 15:18:42 2018 +0900

    add comments to XGraphicStorageHandler.idl
    
    Change-Id: Ib24d9c434f1f19fe7bca51235f6c6125d5c97a7c
    Reviewed-on: https://gerrit.libreoffice.org/51305
    Reviewed-by: Tomaž Vajngerl <quikee at gmail.com>
    Tested-by: Tomaž Vajngerl <quikee at gmail.com>

diff --git a/offapi/com/sun/star/document/XGraphicStorageHandler.idl b/offapi/com/sun/star/document/XGraphicStorageHandler.idl
index 309309aefbf2..9c70132e0d61 100644
--- a/offapi/com/sun/star/document/XGraphicStorageHandler.idl
+++ b/offapi/com/sun/star/document/XGraphicStorageHandler.idl
@@ -15,17 +15,34 @@
 
 module com {  module sun {  module star {  module document {
 
-/** used to load, save and serialize XGraphic objects to the document storage
+/** interface for loading, saving and serializing of XGraphic objects to
+    a document storage
+
+    @since LibreOffice 6.1
  */
 interface XGraphicStorageHandler : com::sun::star::uno::XInterface
 {
+    /** load a graphic defined by the URL from the storage
+    */
     com::sun::star::graphic::XGraphic loadGraphic([in] string aURL);
+
+    /** load a graphic from the output stream
+    */
     com::sun::star::graphic::XGraphic loadGraphicFromOutputStream([in] com::sun::star::io::XOutputStream xOutputStream);
 
+    /** save the graphic to the storage and return the URL reference to
+        its location inside the storage
+    */
     string saveGraphic([in] com::sun::star::graphic::XGraphic xGraphic);
 
+    /** save the graphic to the storage with a requested name and return
+        the URL reference to its location inside the storage and the mime
+        type of the format that the graphic was saved to as an output parameter
+    */
     string saveGraphicByName([in] com::sun::star::graphic::XGraphic xGraphic, [out] string savedMimeType, [in] string aRequestedName);
 
+    /** create an input stream from the input graphic
+    */
     com::sun::star::io::XInputStream createInputStream([in] com::sun::star::graphic::XGraphic xGraphic);
 };