X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=libchimara%2Fresource.c;h=ad5dbf115d1c4a7fc6a3ecb436ba9b61e7c697c5;hb=6478a4f44526dde5ec7b1090d97b2255ed2879a1;hp=c6b4d34dc0cd4433c74461a48f91b988b2847a2e;hpb=e887e681be593844f5b785cab709d6c5a63f175f;p=rodin%2Fchimara.git diff --git a/libchimara/resource.c b/libchimara/resource.c index c6b4d34..ad5dbf1 100644 --- a/libchimara/resource.c +++ b/libchimara/resource.c @@ -4,15 +4,17 @@ extern ChimaraGlkPrivate *glk_data; /** * giblorb_set_resource_map: - * @file The file stream to read the resource map from + * @file: The file stream to read the resource map from * * This function tells the library that the file is indeed the Blorby source * of all resource goodness. Whenever your program calls an image or sound * function, such as glk_image_draw(), the library will search this file for * the resource you request. * - * Do not close the stream after calling this function. The library is - * responsible for closing the stream at shutdown time. + * Do not close the stream after calling this function. + * The library is responsible for closing the stream at shutdown time. + * + * Returns: a Blorb error code. */ giblorb_err_t giblorb_set_resource_map(strid_t file) @@ -40,8 +42,10 @@ giblorb_set_resource_map(strid_t file) /** * giblorb_get_resource_map: * - * This function returns the current resource map being used. Returns NULL - * if #giblorb_set_resource_map() has not been called yet. + * This function returns the current resource map being used. Returns %NULL + * if giblorb_set_resource_map() has not been called yet. + * + * Returns: a resource map, or %NULL. */ giblorb_map_t* giblorb_get_resource_map()