Merge branch 'blender2.7'
[blender.git] / intern / ghost / GHOST_Path-api.h
index 790a529745fe408b34ab33cb0e9b697a47cb8b91..4cdfbf842fed30bc99faf9d604e84de42bb4ac2f 100644 (file)
@@ -1,8 +1,4 @@
 /*
- * $Id$
- *
- * ***** BEGIN GPL LICENSE BLOCK *****
- *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  *
  * The Original Code is Copyright (C) 2010 by Blender Foundation.
  * All rights reserved.
- *
- * The Original Code is: all of this file.
- *
- * Contributor(s): none yet.
- *
- * ***** END GPL LICENSE BLOCK *****
  */
 
-/** \file ghost/GHOST_Path-api.h
- *  \ingroup GHOST
+/** \file
+ * \ingroup GHOST
  */
 
 
-#ifndef        GHOST_PATH_API_H
-#define GHOST_PATH_API_H
+#ifndef __GHOST_PATH_API_H__
+#define __GHOST_PATH_API_H__
 
 #include "GHOST_Types.h"
 
 #ifdef __cplusplus
-extern "C" { 
+extern "C" {
 #endif
 
 GHOST_DECLARE_HANDLE(GHOST_SystemPathsHandle);
 
 /**
  * Creates the one and only instance of the system path access.
- * @return An indication of success.
+ * \return An indication of success.
  */
 extern GHOST_TSuccess GHOST_CreateSystemPaths(void);
 
 /**
  * Disposes the one and only system.
- * @return An indication of success.
+ * \return An indication of success.
  */
 extern GHOST_TSuccess GHOST_DisposeSystemPaths(void);
 
 /**
  * Determine the base dir in which shared resources are located. It will first try to use
- * "unpack and run" path, then look for properly installed path, not including versioning.
- * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
+ * "unpack and run" path, then look for properly installed path, including versioning.
+ * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
  */
-extern const GHOST_TUns8* GHOST_getSystemDir(void);
+extern const GHOST_TUns8 *GHOST_getSystemDir(int version, const char *versionstr);
 
 /**
- * Determine the base dir in which user configuration is stored, not including versioning.
- * @return Unsigned char string pointing to user dir (eg ~).
+ * Determine the base dir in which user configuration is stored, including versioning.
+ * \return Unsigned char string pointing to user dir (eg ~).
  */
-extern const GHOST_TUns8* GHOST_getUserDir(void);
+extern const GHOST_TUns8 *GHOST_getUserDir(int version, const char *versionstr);
 
 
 /**
  * Determine the dir in which the binary file is found.
- * @return Unsigned char string pointing to binary dir (eg ~/usr/local/bin/).
+ * \return Unsigned char string pointing to binary dir (eg ~/usr/local/bin/).
  */
-extern const GHOST_TUns8GHOST_getBinaryDir(void);
+extern const GHOST_TUns8 *GHOST_getBinaryDir(void);
 
 /**
-* Add the file to the operating system most recently used files
-*/
-extern void GHOST_addToSystemRecentFiles(const charfilename);
+ * Add the file to the operating system most recently used files
+ */
+extern void GHOST_addToSystemRecentFiles(const char *filename);
 
 #ifdef __cplusplus
-} 
+}
 #endif
 
 #endif