Skip to content
Permalink
Browse files

Docs++

(cherry-picked from d79221f)
  • Loading branch information
nyalldawson committed Mar 5, 2018
1 parent fe6e967 commit 6d50e31dc8010ee0b802f37eee652436b1a12ab0
Showing with 4 additions and 2 deletions.
  1. +3 −1 python/core/qgsfileutils.sip.in
  2. +1 −1 src/core/qgsfileutils.h
@@ -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
};

@@ -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 );
};

0 comments on commit 6d50e31

Please sign in to comment.
You can’t perform that action at this time.