Docs++

(cherry-picked from d79221f)

python/core/qgsfileutils.sip.in

@@ -72,7 +72,9 @@ will be returned unchanged.
 Converts a ``string`` to a safe filename, replacing characters which are not safe
 for filenames with an '_' character.
 
-This method should be called with file names only, not complete paths.
+.. warning::
+
+   This method strips slashes from the filename, so it is safe to call with file names only, not complete paths.
 %End
 };
 

src/core/qgsfileutils.h

@@ -75,7 +75,7 @@ class CORE_EXPORT QgsFileUtils
      * Converts a \a string to a safe filename, replacing characters which are not safe
      * for filenames with an '_' character.
      *
-     * This method should be called with file names only, not complete paths.
+     * \warning This method strips slashes from the filename, so it is safe to call with file names only, not complete paths.
      */
     static QString stringToSafeFilename( const QString &string );
 };