*
* 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.
*
*
* 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 <emphasis>not</emphasis> close the stream after calling this function.
+ * The library is responsible for closing the stream at shutdown time.
+ *
+ * Returns: a Blorb error code.
giblorb_map_t *newmap; /* create map allocates memory */
giblorb_err_t error = giblorb_create_map(file, &newmap);
giblorb_map_t *newmap; /* create map allocates memory */
giblorb_err_t error = giblorb_create_map(file, &newmap);
- * 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.