Docs++

nyalldawson · nyalldawson · commit d79221f1a24d · 2018-03-05T12:06:50.000+11:00
[ci-skip]
diff --git a/python/core/qgsfileutils.sip.in b/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
 };
 
diff --git a/src/core/qgsfileutils.h b/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 );
 };

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