Commit 80a0ae9f authored by Sebastian Ramacher's avatar Sebastian Ramacher

Fix some spelling mistakes

Signed-off-by: Sebastian Ramacher's avatarSebastian Ramacher <sebastian+dev@ramacher.at>
parent 89460152
......@@ -16,7 +16,7 @@
*
* @param widget The gtk window of zathura
* @param zathura Correspondending zathura session
* @return true if no error occured and the event has been handled
* @return true if no error occurred and the event has been handled
*/
gboolean cb_destroy(GtkWidget* widget, zathura_t* zathura);
......@@ -108,7 +108,7 @@ void cb_index_row_activated(GtkTreeView* tree_view, GtkTreePath* path,
*
* @param entry The dialog inputbar
* @param session The girara session
* @return true if no error occured and the event has been handled
* @return true if no error occurred and the event has been handled
*/
bool cb_sc_follow(GtkEntry* entry, girara_session_t* session);
......@@ -117,7 +117,7 @@ bool cb_sc_follow(GtkEntry* entry, girara_session_t* session);
*
* @param entry The dialog inputbar
* @param session The girara session
* @return true if no error occured and the event has been handled
* @return true if no error occurred and the event has been handled
*/
bool cb_sc_display_link(GtkEntry* entry, girara_session_t* session);
......
......@@ -11,7 +11,7 @@
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_bookmark_create(girara_session_t* session, girara_list_t* argument_list);
......@@ -20,7 +20,7 @@ bool cmd_bookmark_create(girara_session_t* session, girara_list_t* argument_list
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_bookmark_delete(girara_session_t* session, girara_list_t* argument_list);
......@@ -29,7 +29,7 @@ bool cmd_bookmark_delete(girara_session_t* session, girara_list_t* argument_list
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_bookmark_open(girara_session_t* session, girara_list_t* argument_list);
......@@ -38,7 +38,7 @@ bool cmd_bookmark_open(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_close(girara_session_t* session, girara_list_t* argument_list);
......@@ -47,7 +47,7 @@ bool cmd_close(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_info(girara_session_t* session, girara_list_t* argument_list);
......@@ -56,7 +56,7 @@ bool cmd_info(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_help(girara_session_t* session, girara_list_t* argument_list);
......@@ -65,7 +65,7 @@ bool cmd_help(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_hlsearch(girara_session_t* session, girara_list_t* argument_list);
......@@ -74,7 +74,7 @@ bool cmd_hlsearch(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_open(girara_session_t* session, girara_list_t* argument_list);
......@@ -83,7 +83,7 @@ bool cmd_open(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_print(girara_session_t* session, girara_list_t* argument_list);
......@@ -92,7 +92,7 @@ bool cmd_print(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_nohlsearch(girara_session_t* session, girara_list_t* argument_list);
......@@ -101,7 +101,7 @@ bool cmd_nohlsearch(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_quit(girara_session_t* session, girara_list_t* argument_list);
......@@ -110,7 +110,7 @@ bool cmd_quit(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_save(girara_session_t* session, girara_list_t* argument_list);
......@@ -119,7 +119,7 @@ bool cmd_save(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_savef(girara_session_t* session, girara_list_t* argument_list);
......@@ -129,7 +129,7 @@ bool cmd_savef(girara_session_t* session, girara_list_t* argument_list);
* @param session The used girara session
* @param input The current input
* @param argument Passed argument
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_search(girara_session_t* session, const char* input, girara_argument_t* argument);
......@@ -138,7 +138,7 @@ bool cmd_search(girara_session_t* session, const char* input, girara_argument_t*
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_export(girara_session_t* session, girara_list_t* argument_list);
......@@ -147,7 +147,7 @@ bool cmd_export(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_exec(girara_session_t* session, girara_list_t* argument_list);
......@@ -156,7 +156,7 @@ bool cmd_exec(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_offset(girara_session_t* session, girara_list_t* argument_list);
......@@ -165,7 +165,7 @@ bool cmd_offset(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The used girara session
* @param argument_list List of passed arguments
* @return true if no error occured
* @return true if no error occurred
*/
bool cmd_version(girara_session_t* session, girara_list_t* argument_list);
......
......@@ -11,7 +11,7 @@
*
* @param session The used girara session
* @param input The current input
* @return The completion object or NULL if an error occured
* @return The completion object or NULL if an error occurred
*/
girara_completion_t* cc_open(girara_session_t* session, const char* input);
......@@ -21,7 +21,7 @@ girara_completion_t* cc_open(girara_session_t* session, const char* input);
*
* @param session The used girara session
* @param input The current input
* @return The completion object or NULL if an error occured
* @return The completion object or NULL if an error occurred
*/
girara_completion_t* cc_write(girara_session_t* session, const char* input);
......@@ -30,7 +30,7 @@ girara_completion_t* cc_write(girara_session_t* session, const char* input);
*
* @param session The used girara session
* @param input The current input
* @return The completion object or NULL if an error occured
* @return The completion object or NULL if an error occurred
*/
girara_completion_t* cc_bookmarks(girara_session_t* session, const char* input);
......
......@@ -25,7 +25,7 @@ zathura_document_t* zathura_document_open(zathura_t* zathura,
* Free the document
*
* @param document
* @return ZATHURA_ERROR_OK when no error occured, otherwise see
* @return ZATHURA_ERROR_OK when no error occurred, otherwise see
* zathura_error_t
*/
zathura_error_t zathura_document_free(zathura_document_t* document);
......@@ -67,7 +67,7 @@ const char* zathura_document_get_password(zathura_document_t* document);
*
* @param document The document
* @param index The index of the page
* @return The page or NULL if an error occured
* @return The page or NULL if an error occurred
*/
zathura_page_t* zathura_document_get_page(zathura_document_t* document, unsigned int index);
......@@ -283,7 +283,7 @@ void zathura_document_set_page_layout(zathura_document_t* document, unsigned int
unsigned int pages_per_row, unsigned int first_page_column);
/**
* Returns the padding in pixels betwen pages
* Returns the padding in pixels between pages
*
* @param document The document
* @return The padding in pixels between pages
......@@ -311,7 +311,7 @@ unsigned int zathura_document_get_first_page_column(zathura_document_t* document
*
* @param document The document object
* @param path Path for the saved file
* @return ZATHURA_ERROR_OK when no error occured, otherwise see
* @return ZATHURA_ERROR_OK when no error occurred, otherwise see
* zathura_error_t
*/
zathura_error_t zathura_document_save_as(zathura_document_t* document, const char* path);
......@@ -321,7 +321,7 @@ zathura_error_t zathura_document_save_as(zathura_document_t* document, const cha
*
* @param document The document object
* @param error Set to an error value (see \ref zathura_error_t) if an
* error occured
* error occurred
* @return Generated index
*/
......@@ -332,7 +332,7 @@ girara_tree_node_t* zathura_document_index_generate(zathura_document_t* document
*
* @param document The document object
* @param error Set to an error value (see \ref zathura_error_t) if an
* error occured
* error occurred
* @return List of attachments
*/
girara_list_t* zathura_document_attachments_get(zathura_document_t* document, zathura_error_t* error);
......@@ -343,7 +343,7 @@ girara_list_t* zathura_document_attachments_get(zathura_document_t* document, za
* @param document The document objects
* @param attachment name of the attachment
* @param file the target filename
* @return ZATHURA_ERROR_OK when no error occured, otherwise see
* @return ZATHURA_ERROR_OK when no error occurred, otherwise see
* zathura_error_t
*/
zathura_error_t zathura_document_attachment_save(zathura_document_t* document, const char* attachment, const char* file);
......@@ -353,8 +353,8 @@ zathura_error_t zathura_document_attachment_save(zathura_document_t* document, c
*
* @param document The zathura document
* @param error Set to an error value (see \ref zathura_error_t) if an
* error occured
* @return List of document information entries or NULL if information could not be retreived
* error occurred
* @return List of document information entries or NULL if information could not be retrieved
*/
girara_list_t* zathura_document_get_information(zathura_document_t* document, zathura_error_t* error);
......
......@@ -16,7 +16,7 @@ typedef struct zathura_mark_s zathura_mark_t;
* @param argument The used argument
* @param event Girara event
* @param t Number of executions
* @return true if no error occured otherwise false
* @return true if no error occurred otherwise false
*/
bool sc_mark_add(girara_session_t* session, girara_argument_t* argument,
girara_event_t* event, unsigned int t);
......@@ -28,7 +28,7 @@ bool sc_mark_add(girara_session_t* session, girara_argument_t* argument,
* @param argument The used argument
* @param event Girara event
* @param t Number of executions
* @return true if no error occured otherwise false
* @return true if no error occurred otherwise false
*/
bool sc_mark_evaluate(girara_session_t* session, girara_argument_t* argument,
girara_event_t* event, unsigned int t);
......@@ -38,7 +38,7 @@ bool sc_mark_evaluate(girara_session_t* session, girara_argument_t* argument,
*
* @param session The girara session
* @param argument_list Argument list
* @return true if no error occured otherwise false
* @return true if no error occurred otherwise false
*/
bool cmd_marks_add(girara_session_t* session, girara_list_t* argument_list);
......@@ -47,7 +47,7 @@ bool cmd_marks_add(girara_session_t* session, girara_list_t* argument_list);
*
* @param session The girara session
* @param argument_list Argument list
* @return true if no error occured otherwise false
* @return true if no error occurred otherwise false
*/
bool cmd_marks_delete(girara_session_t* session, girara_list_t* argument_list);
......
......@@ -75,7 +75,7 @@ void zathura_page_widget_clear_rectangles(ZathuraPage* widget);
*
* @param widget the widget
* @param index Index of the link
* @return Link object or NULL if an error occured
* @return Link object or NULL if an error occurred
*/
zathura_link_t* zathura_page_widget_link_get(ZathuraPage* widget, unsigned int index);
/**
......
......@@ -14,7 +14,7 @@
* @param document The document
* @param index Page number
* @param error Optional error
* @return Page object or NULL if an error occured
* @return Page object or NULL if an error occurred
*/
zathura_page_t* zathura_page_new(zathura_document_t* document, unsigned int
index, zathura_error_t* error);
......@@ -23,7 +23,7 @@ zathura_page_t* zathura_page_new(zathura_document_t* document, unsigned int
* Frees the page object
*
* @param page The page object
* @return ZATHURA_ERROR_OK when no error occured, otherwise see
* @return ZATHURA_ERROR_OK when no error occurred, otherwise see
* zathura_error_t
*/
zathura_error_t zathura_page_free(zathura_page_t* page);
......@@ -33,7 +33,7 @@ zathura_error_t zathura_page_free(zathura_page_t* page);
*
* @param page The page object
* @return The associated document
* @return NULL if an error occured
* @return NULL if an error occurred
*/
zathura_document_t* zathura_page_get_document(zathura_page_t* page);
......@@ -50,7 +50,7 @@ unsigned int zathura_page_get_index(zathura_page_t* page);
*
* @param page The page object
* @return Width of the page
* @return -1 If an error occured
* @return -1 If an error occurred
*/
double zathura_page_get_width(zathura_page_t* page);
......@@ -67,7 +67,7 @@ void zathura_page_set_width(zathura_page_t* page, double width);
*
* @param page The page object
* @return Height of the page
* @return -1 If an error occured
* @return -1 If an error occurred
*/
double zathura_page_get_height(zathura_page_t* page);
......@@ -118,7 +118,7 @@ void zathura_page_set_data(zathura_page_t* page, void* data);
* @param page The page object
* @param text Search item
* @param error Set to an error value (see \ref zathura_error_t) if an
* error occured
* error occurred
* @return List of results
*/
girara_list_t* zathura_page_search_text(zathura_page_t* page, const char* text, zathura_error_t* error);
......@@ -128,7 +128,7 @@ girara_list_t* zathura_page_search_text(zathura_page_t* page, const char* text,
*
* @param page The page object
* @param error Set to an error value (see \ref zathura_error_t) if an
* error occured
* error occurred
* @return List of links
*/
girara_list_t* zathura_page_links_get(zathura_page_t* page, zathura_error_t* error);
......@@ -137,7 +137,7 @@ girara_list_t* zathura_page_links_get(zathura_page_t* page, zathura_error_t* err
* Free page links
*
* @param list List of links
* @return ZATHURA_ERROR_OK when no error occured, otherwise see
* @return ZATHURA_ERROR_OK when no error occurred, otherwise see
* zathura_error_t
*/
zathura_error_t zathura_page_links_free(girara_list_t* list);
......@@ -147,7 +147,7 @@ zathura_error_t zathura_page_links_free(girara_list_t* list);
*
* @param page The page object
* @param error Set to an error value (see \ref zathura_error_t) if an
* error occured
* error occurred
* @return List of form fields
*/
girara_list_t* zathura_page_form_fields_get(zathura_page_t* page, zathura_error_t* error);
......@@ -156,7 +156,7 @@ girara_list_t* zathura_page_form_fields_get(zathura_page_t* page, zathura_error_
* Free list of form fields
*
* @param list List of form fields
* @return ZATHURA_ERROR_OK when no error occured, otherwise see
* @return ZATHURA_ERROR_OK when no error occurred, otherwise see
* zathura_error_t
*/
zathura_error_t zathura_page_form_fields_free(girara_list_t* list);
......@@ -166,8 +166,8 @@ zathura_error_t zathura_page_form_fields_free(girara_list_t* list);
*
* @param page Page
* @param error Set to an error value (see \ref zathura_error_t) if an
* error occured
* @return List of images or NULL if an error occured
* error occurred
* @return List of images or NULL if an error occurred
*/
girara_list_t* zathura_page_images_get(zathura_page_t* page, zathura_error_t* error);
......@@ -177,8 +177,8 @@ girara_list_t* zathura_page_images_get(zathura_page_t* page, zathura_error_t* er
* @param page Page
* @param image Image identifier
* @param error Set to an error value (see \ref zathura_error_t) if an
* error occured
* @return The cairo image surface or NULL if an error occured
* error occurred
* @return The cairo image surface or NULL if an error occurred
*/
cairo_surface_t* zathura_page_image_get_cairo(zathura_page_t* page, zathura_image_t* image, zathura_error_t* error);
......@@ -187,7 +187,7 @@ cairo_surface_t* zathura_page_image_get_cairo(zathura_page_t* page, zathura_imag
* @param page Page
* @param rectangle Selection
* @param error Set to an error value (see \ref zathura_error_t) if an error
* occured
* occurred
* @return The selected text (needs to be deallocated with g_free)
*/
char* zathura_page_get_text(zathura_page_t* page, zathura_rectangle_t rectangle, zathura_error_t* error);
......@@ -198,7 +198,7 @@ char* zathura_page_get_text(zathura_page_t* page, zathura_rectangle_t rectangle,
* @param page The page object
* @param cairo Cairo object
* @param printing render for printing
* @return ZATHURA_ERROR_OK when no error occured, otherwise see
* @return ZATHURA_ERROR_OK when no error occurred, otherwise see
* zathura_error_t
*/
zathura_error_t zathura_page_render(zathura_page_t* page, cairo_t* cairo, bool printing);
......
......@@ -27,7 +27,7 @@ typedef struct zathura_plugin_version_s {
/**
* Creates a new instance of the plugin manager
*
* @return A plugin manager object or NULL if an error occured
* @return A plugin manager object or NULL if an error occurred
*/
zathura_plugin_manager_t* zathura_plugin_manager_new(void);
......
......@@ -55,7 +55,7 @@ bool zathura_renderer_recolor_enabled(ZathuraRenderer* renderer);
/**
* Enable/disable recoloring.
* @param renderer a renderer object
* @param enable wheter to enable or disable recoloring
* @param enable whether to enable or disable recoloring
*/
void zathura_renderer_enable_recolor(ZathuraRenderer* renderer, bool enable);
/**
......@@ -67,7 +67,7 @@ bool zathura_renderer_recolor_hue_enabled(ZathuraRenderer* renderer);
/**
* Enable/disable preservation of hue while recoloring.
* @param renderer a renderer object
* @param enable wheter to enable or disable hue preservation
* @param enable whether to enable or disable hue preservation
*/
void zathura_renderer_enable_recolor_hue(ZathuraRenderer* renderer,
bool enable);
......
This diff is collapsed.
......@@ -45,8 +45,8 @@ typedef struct zathura_dbus_s ZathuraDbus;
*/
typedef enum zathura_plugin_error_e
{
ZATHURA_ERROR_OK, /**< No error occured */
ZATHURA_ERROR_UNKNOWN, /**< An unknown error occured */
ZATHURA_ERROR_OK, /**< No error occurred */
ZATHURA_ERROR_UNKNOWN, /**< An unknown error occurred */
ZATHURA_ERROR_OUT_OF_MEMORY, /**< Out of memory */
ZATHURA_ERROR_NOT_IMPLEMENTED, /**< The called function has not been implemented */
ZATHURA_ERROR_INVALID_ARGUMENTS, /**< Invalid arguments have been passed */
......@@ -109,7 +109,7 @@ typedef enum zathura_adjust_mode_e
*
* @param width Width of the image stored in the buffer
* @param height Height of the image stored in the buffer
* @return Image buffer or NULL if an error occured
* @return Image buffer or NULL if an error occurred
*/
zathura_image_buffer_t* zathura_image_buffer_create(unsigned int width, unsigned int height);
......@@ -232,7 +232,7 @@ void zathura_index_element_free(zathura_index_element_t* index);
* Creates a list that should be used to store \ref
* zathura_document_information_entry_t entries
*
* @return A list or NULL if an error occured
* @return A list or NULL if an error occurred
*/
girara_list_t* zathura_document_information_entry_list_new();
......@@ -242,7 +242,7 @@ girara_list_t* zathura_document_information_entry_list_new();
* @param type The type
* @param value The value
*
* @return A new entry or NULL if an error occured
* @return A new entry or NULL if an error occurred
*/
zathura_document_information_entry_t*
zathura_document_information_entry_new(zathura_document_information_type_t
......
......@@ -28,7 +28,7 @@ typedef struct page_offset_s
bool file_valid_extension(zathura_t* zathura, const char* path);
/**
* Generates the document index based upon the list retreived from the document
* Generates the document index based upon the list retrieved from the document
* object.
*
* @param model The tree model
......@@ -64,7 +64,7 @@ zathura_rectangle_t recalc_rectangle(zathura_page_t* page, zathura_rectangle_t r
* @param zathura The zathura instance
* @param page The page object
* @return The page widget of the page
* @return NULL if an error occured
* @return NULL if an error occurred
*/
GtkWidget* zathura_page_get_widget(zathura_t* zathura, zathura_page_t* page);
......
......@@ -311,7 +311,7 @@ void zathura_set_argv(zathura_t* zathura, char** argv);
* @param password The password of the file
* @param page_number Open given page number
*
* @return If no error occured true, otherwise false, is returned.
* @return If no error occurred true, otherwise false, is returned.
*/
bool document_open(zathura_t* zathura, const char* path, const char* uri, const char* password,
int page_number);
......@@ -324,7 +324,7 @@ bool document_open(zathura_t* zathura, const char* path, const char* uri, const
* @param password The password of the file
* @param synctex Open at the given SyncTeX string
*
* @return If no error occured true, otherwise false, is returned.
* @return If no error occurred true, otherwise false, is returned.
*/
bool document_open_synctex(zathura_t* zathura, const char* path, const char* uri,
const char* password, const char* synctex);
......@@ -350,7 +350,7 @@ void document_open_idle(zathura_t* zathura, const char* path,
* @param path The path
* @param overwrite Overwrite existing file
*
* @return If no error occured true, otherwise false, is returned.
* @return If no error occurred true, otherwise false, is returned.
*/
bool document_save(zathura_t* zathura, const char* path, bool overwrite);
......@@ -359,7 +359,7 @@ bool document_save(zathura_t* zathura, const char* path, bool overwrite);
*
* @param zathura The zathura session
* @param keep_monitor Set to true if monitor should be kept (sc_reload)
* @return If no error occured true, otherwise false, is returned.
* @return If no error occurred true, otherwise false, is returned.
*/
bool document_close(zathura_t* zathura, bool keep_monitor);
......@@ -368,7 +368,7 @@ bool document_close(zathura_t* zathura, bool keep_monitor);
*
* @param zathura The zathura session
* @param page_id The id of the page that should be set
* @return If no error occured true, otherwise false, is returned.
* @return If no error occurred true, otherwise false, is returned.
*/
bool page_set(zathura_t* zathura, unsigned int page_id);
......@@ -378,7 +378,7 @@ bool page_set(zathura_t* zathura, unsigned int page_id);
* @param zathura Zathura session
* @param position_x X coordinate
* @param position_y Y coordinate
* @return If no error occured true, otherwise false, is returned.
* @return If no error occurred true, otherwise false, is returned.
*/
bool position_set(zathura_t* zathura, double position_x, double position_y);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment