[Libreoffice-commits] core.git: 6 commits - include/vcl vcl/inc

[Chris Sherlock]

 include/vcl/imagerepository.hxx     |    3 +++
 include/vcl/opengl/OpenGLHelper.hxx |    7 ++++++-
 include/vcl/vclptr.hxx              |    2 +-
 include/vcl/virdev.hxx              |    2 +-
 vcl/inc/salgdiimpl.hxx              |    6 ------
 vcl/inc/sft.hxx                     |    4 ++++
 6 files changed, 15 insertions(+), 9 deletions(-)

New commits:
commit c5c5626dd564d07145bb898adf6815cb56c7199b
Author: Chris Sherlock <chris.sherlock79 at gmail.com>
Date:   Fri Jan 8 17:37:01 2016 +1100

    vcl: document some OpenGL parameters
    
    Change-Id: I3e3982170e9f0f898d88fdfed2c5004dfffc6aed

diff --git a/include/vcl/opengl/OpenGLHelper.hxx b/include/vcl/opengl/OpenGLHelper.hxx
index 5e1e86e..4b92fb9 100644
--- a/include/vcl/opengl/OpenGLHelper.hxx
+++ b/include/vcl/opengl/OpenGLHelper.hxx
@@ -63,7 +63,12 @@ public:
     /**
      * The caller is responsible for deleting the buffer objects identified by
      * nFramebufferId, nRenderbufferDepthId and nRenderbufferColorId
-     * @param bRenderbuffer true => off-screen rendering, false => rendering to texture
+     * @param nWidth                Width of frame
+     * @param nHeight               Height of frame
+     * @param nFramebufferId        FrameBuffer ID
+     * @param nRenderbufferDepthID  RenderBuffer's depth ID
+     * @param nRenderbufferColorID  RenderBuffer's color ID
+     * @param bRenderbuffer         true => off-screen rendering, false => rendering to texture
      *          This also affects whether to free with glDeleteRenderbuffers or glDeleteTextures
      */
     static void createFramebuffer(long nWidth, long nHeight, GLuint& nFramebufferId,
commit 8d481730c1936e159b628effe6de4dd043cdebb8
Author: Chris Sherlock <chris.sherlock79 at gmail.com>
Date:   Fri Jan 8 17:26:26 2016 +1100

    vcl: document parameter of loadImage
    
    Change-Id: Icbd617c3ce1571a867e0ebe749d40125275631a6

diff --git a/include/vcl/imagerepository.hxx b/include/vcl/imagerepository.hxx
index f6c50f2..f24c49a 100644
--- a/include/vcl/imagerepository.hxx
+++ b/include/vcl/imagerepository.hxx
@@ -44,6 +44,9 @@ namespace vcl
                 will take the image upon successful return.
             @param  bSearchLanguageDependent
                 determines whether a language-dependent image is to be searched.
+            @param  loadMissing
+                if set to true, then load a default image if no image can be found,
+                otherwise don't load anything
             @return
                 whether or not the image could be loaded successfully.
         */
commit bb7a9dc584cdf4ebe2137c5474571eaef311038b
Author: Chris Sherlock <chris.sherlock79 at gmail.com>
Date:   Fri Jan 8 17:23:41 2016 +1100

    vcl: document parameter in vertical font functions
    
    Change-Id: I07b543c74570de6d1424aef5d9b3a932bdffb92a

diff --git a/vcl/inc/sft.hxx b/vcl/inc/sft.hxx
index c3708f0..7d4a88d 100644
--- a/vcl/inc/sft.hxx
+++ b/vcl/inc/sft.hxx
@@ -482,6 +482,8 @@ namespace vcl
  *
  * @param ttf         pointer to the TrueTypeFont structure
  * @param ch          Unicode (UCS-2) character
+ * @param bvertical   flag to function that we want to find the vertical
+ *                    GlobalSUBstitution attribute
  * @return glyph ID, if the character is missing in the font, the return value is 0.
  * @ingroup sft
  */
@@ -492,6 +494,8 @@ namespace vcl
  * Returns 0 when the font does not substitute vertical glyphs
  *
  * @param ttf         pointer to the TrueTypeFont structure
+ * @param bvertical   flag to function that we want to find the vertical
+ *                    GlobalSUBstitution attribute
  */
     int DoesVerticalSubstitution( TrueTypeFont *ttf, int bvertical);
 
commit deadfe8ec9ed871fdd9b81868c1224ad7a1ee310
Author: Chris Sherlock <chris.sherlock79 at gmail.com>
Date:   Fri Jan 8 17:20:58 2016 +1100

    vcl: fix Doxygen parameter name
    
    Change-Id: I64566aa7dcd3c50e083180945d08039dd89364b3

diff --git a/include/vcl/virdev.hxx b/include/vcl/virdev.hxx
index c48f10d..f31bc4e 100644
--- a/include/vcl/virdev.hxx
+++ b/include/vcl/virdev.hxx
@@ -72,7 +72,7 @@ public:
 
     /** Create a virtual device of size 1x1
 
-        @param nBitCount
+        @param eFormat
         Device format of the generated virtual device. Use DeviceFormat::DEFAULT here, to
         indicate: take default screen depth. Only DeviceFormat::BITMASK
         is the other possibility to denote a binary mask.
commit bc9879b0f1c35211e3df045c522b8e5e1ead0fd1
Author: Chris Sherlock <chris.sherlock79 at gmail.com>
Date:   Fri Jan 8 17:19:09 2016 +1100

    vcl: should be using @tparam for template parameters
    
    Change-Id: I650448b4c24173a88b594185c2332861288ec753

diff --git a/include/vcl/vclptr.hxx b/include/vcl/vclptr.hxx
index 3309cb5..436a358 100644
--- a/include/vcl/vclptr.hxx
+++ b/include/vcl/vclptr.hxx
@@ -124,7 +124,7 @@ public:
      *
      * For more details on the design please see vcl/README.lifecycle
      *
-     * @param reference_type must be a subclass of vcl::Window
+     * @tparam reference_type must be a subclass of vcl::Window
      */
     template<typename... Arg> static VclPtr< reference_type > Create(Arg &&... arg)
     {
commit 48324355de9546e99e81a524c3947567de8db555
Author: Chris Sherlock <chris.sherlock79 at gmail.com>
Date:   Fri Jan 8 17:15:00 2016 +1100

    vcl: this function is already documented in the base class
    
    Change-Id: I6efa86e797012b214257e745f7c7bbab0ac38461

diff --git a/vcl/inc/salgdiimpl.hxx b/vcl/inc/salgdiimpl.hxx
index 5aecb48..a70fe2c 100644
--- a/vcl/inc/salgdiimpl.hxx
+++ b/vcl/inc/salgdiimpl.hxx
@@ -187,12 +187,6 @@ public:
                 const SalBitmap& rSourceBitmap,
                 const SalBitmap* pAlphaBitmap) = 0;
 
-    /** Render solid rectangle with given transparency
-
-        @param nTransparency
-        Transparency value (0-255) to use. 0 blits and opaque, 255 a
-        fully transparent rectangle
-     */
     virtual bool drawAlphaRect(
                     long nX, long nY,
                     long nWidth, long nHeight,