Change return type and name of get_win_special_folder

Rename it get_win_special_folder_path to indicate what it is returning

Move documentation for the function into the header and use doxygen style
comments.

Fixes a couple of memory leaks in ArdourVideoToolPaths class although it looks
as if there are more.

1 files changed, 13 insertions, 1 deletions

diff --git a/libs/pbd/pbd/windows_special_dirs.h b/libs/pbd/pbd/windows_special_dirs.h
index c557ef4c16..0bc5accc96 100644
--- a/libs/pbd/pbd/windows_special_dirs.h
+++ b/libs/pbd/pbd/windows_special_dirs.h
@@ -20,10 +20,22 @@
 #ifndef __libpbd_windows_special_dirs_h__
 #define __libpbd_windows_special_dirs_h__
 
+#include <string>
+
 #include "pbd/libpbd_visibility.h"
 
 namespace PBD {
-	LIBPBD_API char * get_win_special_folder (int csidl);
+
+/**
+* Gets the full path that corresponds of one of the Windows special folders,
+* such as "My Documents" and the like.
+*
+* @param csidl corresponds to CSIDL values, such as CSIDL_SYSTEM etc.
+* @return A string containing the name of the special folder or an empty
+* string on failure.
+*/
+LIBPBD_API std::string get_win_special_folder_path (int csidl);
+
 }
 
 #endif /* __libpbd_windows_special_dirs_h__ */