[svn r12620] Minor change - added examples for all the api_get_path() cases - This will presumably save a lot of seconds in the future.

main/inc/lib/main_api.lib.php

@@ -314,45 +314,60 @@ function api_get_path($path_type)
 			break;
 
 		case REL_COURSE_PATH :
+			// example: courses/ or dokeos/courses/
 			return api_get_path(REL_PATH).$_configuration['course_folder'];
 			break;
 		case REL_CLARO_PATH :
+			// example: main/ or dokeos/main/
 			return api_get_path(REL_PATH).$_configuration['code_append'];
 			break;
 		case WEB_CODE_PATH :
+			// example: http://www.mydokeos.com/main/
 			return $GLOBALS['clarolineRepositoryWeb'];
 			break;
 		case SYS_CODE_PATH :
+			// example: /var/www/dokeos/main/
 			return $GLOBALS['clarolineRepositorySys'];
 			break;
 		case SYS_LANG_PATH :
+			// example: /var/www/dokeos/main/lang/
 			return api_get_path(SYS_CODE_PATH).'lang/';
 			break;
 		case WEB_IMG_PATH :
+			// example: http://www.mydokeos.com/main/img/
 			return api_get_path(WEB_CODE_PATH).'img/';
 			break;
 		case GARBAGE_PATH :
+			// example: /var/www/dokeos/main/garbage/
 			return $GLOBALS['garbageRepositorySys'];
 			break;
 		case SYS_PLUGIN_PATH :
+			// example: /var/www/dokeos/plugin/
 			return api_get_path(SYS_PATH).'plugin/';
 			break;
 		case WEB_PLUGIN_PATH :
+			// example: http://www.mydokeos.com/plugin/
 			return api_get_path(WEB_PATH).'plugin/';
 			break;
 		case SYS_ARCHIVE_PATH :
+			// example: /var/www/dokeos/archive/
 			return api_get_path(SYS_PATH).'archive/';
 			break;
 		case INCLUDE_PATH :
+			// Generated by main/inc/global.inc.php 
+			// example: /var/www/dokeos/main/inc/
 			return str_replace('\\', '/', $GLOBALS['includePath']).'/';
 			break;
 		case LIBRARY_PATH :
+			// example: /var/www/dokeos/main/inc/lib/
 			return api_get_path(INCLUDE_PATH).'lib/';
 			break;
 		case WEB_LIBRARY_PATH :
+			// example: http://www.mydokeos.com/main/inc/lib/
 			return api_get_path(WEB_CODE_PATH).'inc/lib/';
 			break;
 		case CONFIGURATION_PATH :
+			// example: /var/www/dokeos/main/inc/conf/
 			return api_get_path(INCLUDE_PATH).'conf/';
 			break;
 		default :