1 files changed, 10 insertions, 0 deletions
diff --git a/basebmp/inc/basebmp/debug.hxx b/basebmp/inc/basebmp/debug.hxx
index 0193af7e1498..0a8c7219318d 100644
--- a/basebmp/inc/basebmp/debug.hxx
+++ b/basebmp/inc/basebmp/debug.hxx
@@ -46,6 +46,16 @@ namespace basebmp
         Stream to write output to.
 
         Used in vcl/headless/svpgdi.cxx when OSL_DEBUG_LEVEL > 2
+
+        Use like this:
+<pre>
+        #include <basebmp/debug.hxx>
+        #include <iostream>
+        #include <fstream>
+
+        std::ofstream output("/tmp/my_test.dump");
+        debugDump( pMyDevice, output );
+</pre>
     */
     void BASEBMP_DLLPUBLIC debugDump( const boost::shared_ptr< BitmapDevice >& rDevice,
                                       ::std::ostream&                          rOutputStream );