[Doc] Add some header documentation.

This commit is contained in:
Dave Davenport 2021-06-15 17:22:39 +02:00
parent 4c1a74e15e
commit 6e2584ffc8
1 changed files with 14 additions and 0 deletions

View File

@ -35,6 +35,20 @@ void rofi_icon_fetcher_destroy ( void );
* @returns the uid identifying the request.
*/
uint32_t rofi_icon_fetcher_query ( const char *name, const int size );
/**
* @param name The name of the icon to fetch.
* @param wsize The width of the icon to fetch.
* @param hsize The height of the icon to fetch.
*
* Query the icon-theme for icon with name and size.
* The returned icon will be the best match for the requested size, it should still be resized to the actual size.
* For icons it will take the min of wsize and hsize.
*
* name can also be a full path, if prefixed with file://.
*
* @returns the uid identifying the request.
*/
uint32_t rofi_icon_fetcher_query_advanced ( const char *name, const int wsize, const int hsize );
/**