mirror of
https://git.pwmt.org/pwmt/zathura.git
synced 2024-11-10 21:53:46 +01:00
Update documentation
This commit is contained in:
parent
11e3e222f5
commit
c7d77a1030
@ -12,8 +12,10 @@
|
||||
* desired.
|
||||
*
|
||||
* @param document the document
|
||||
* @param height width the original height and width
|
||||
* @return page_height page_width the scaled and rotated height and width
|
||||
* @param height the original height
|
||||
* @param width the original width
|
||||
* @param page_height the scaled and rotated height
|
||||
* @param page_width the scaled and rotated width
|
||||
* @param rotate honor page's rotation
|
||||
* @return real scale after rounding
|
||||
*/
|
||||
@ -26,8 +28,10 @@ double page_calc_height_width(zathura_document_t* document, double height, doubl
|
||||
* relative to the entire document.
|
||||
*
|
||||
* @param document the document
|
||||
* @param x y the x y coordinates on the unrotated page
|
||||
* @param xn yn the x y coordinates after rotation
|
||||
* @param x the x coordinates on the unrotated page
|
||||
* @param y the y coordinates on the unrotated page
|
||||
* @param xn the x coordinates after rotation
|
||||
* @param yn the y coordinates after rotation
|
||||
*/
|
||||
void page_calc_position(zathura_document_t* document, double x, double y,
|
||||
double *xn, double *yn);
|
||||
@ -36,7 +40,8 @@ void page_calc_position(zathura_document_t* document, double x, double y,
|
||||
* Converts a relative position within the document to a page number.
|
||||
*
|
||||
* @param document The document
|
||||
* @param pos_x pos_y the position relative to the document
|
||||
* @param pos_x the x position relative to the document
|
||||
* @param pos_y the y position relative to the document
|
||||
* @return page sitting in that position
|
||||
*/
|
||||
unsigned int position_to_page_number(zathura_document_t* document,
|
||||
@ -54,8 +59,10 @@ unsigned int position_to_page_number(zathura_document_t* document,
|
||||
*
|
||||
* @param document The document
|
||||
* @param page_number the given page number
|
||||
* @param xalign yalign where to align the viewport and the page
|
||||
* @return pos_x pos_y position that will lie at the center of the viewport.
|
||||
* @param xalign where to align the viewport and the page
|
||||
* @param yalign where to align the viewport and the page
|
||||
* @param pos_x position that will lie at the center of the viewport.
|
||||
* @param pos_y position that will lie at the center of the viewport.
|
||||
*/
|
||||
void page_number_to_position(zathura_document_t* document, unsigned int page_number,
|
||||
double xalign, double yalign, double *pos_x, double *pos_y);
|
||||
|
@ -201,7 +201,7 @@ bool cb_unknown_command(girara_session_t* session, const char* input);
|
||||
/**
|
||||
* Emitted when text has been selected in the page widget
|
||||
*
|
||||
* @param widget page view widget
|
||||
* @param page page view widget
|
||||
* @param text selected text
|
||||
* @param data user data
|
||||
*/
|
||||
|
@ -16,7 +16,6 @@ void config_load_default(zathura_t* zathura);
|
||||
* Loads and evaluates a configuration file
|
||||
*
|
||||
* @param zathura The zathura session
|
||||
* @param path Path to the configuration file
|
||||
*/
|
||||
void config_load_files(zathura_t* zathura);
|
||||
|
||||
|
@ -195,7 +195,7 @@ void zathura_render_request(ZathuraRenderRequest* request,
|
||||
/**
|
||||
* Abort an existing render request.
|
||||
*
|
||||
* @param reqeust request that should be aborted
|
||||
* @param request request that should be aborted
|
||||
*/
|
||||
void zathura_render_request_abort(ZathuraRenderRequest* request);
|
||||
|
||||
|
@ -284,6 +284,7 @@ void zathura_set_argv(zathura_t* zathura, char** argv);
|
||||
* @param zathura The zathura session
|
||||
* @param path The path to the file
|
||||
* @param password The password of the file
|
||||
* @param page_number Open given page number
|
||||
*
|
||||
* @return If no error occured true, otherwise false, is returned.
|
||||
*/
|
||||
@ -296,6 +297,8 @@ bool document_open(zathura_t* zathura, const char* path, const char* password,
|
||||
* @param zathura The zathura session
|
||||
* @param path The path to the file
|
||||
* @param password The password of the file
|
||||
* @param page_number Open given page number
|
||||
* @param mode Open in given page mode
|
||||
*/
|
||||
void document_open_idle(zathura_t* zathura, const char* path,
|
||||
const char* password, int page_number,
|
||||
|
Loading…
Reference in New Issue
Block a user