Skip to content

Commit

Permalink
include/core: Update documentation for nvd_init
Browse files Browse the repository at this point in the history
  • Loading branch information
tseli0s committed Jan 20, 2024
1 parent 3883d6f commit 9a8c306
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions include/nvdialog_core.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,11 @@ typedef void *NvdParentWindow;
* @note You should call this function to the same thread you're creating your dialogs from.
* If you also happen to use a library used by NvDialog as the backend, make sure that the two libraries
* stay in the same thread to avoid race conditions.
* @param program The argv[0] of your program, required on some backends.
* @since v0.1.0
* @ingroup Core
* @return 0 on success, else a negative error code indicating failure.
*/
NVD_API int nvd_init(char *program);
NVD_API int nvd_init();

/**
* @brief Sets the application name to use inside NvDialog.
Expand All @@ -78,6 +77,7 @@ NVD_API const char *nvd_get_application_name();
* @brief Returns the argv[0] given to nvdialog.
* @details This function returns the parameter passed to nvdialog during
* nvd_init. It is mainly intended to be used internally.
* @deprecated This function is deprecated as of v0.8.1 and will only return NULL
* @return The argv[0] given to nvdialog on success, otherwise NULL.
*/
NVD_API const char *nvd_get_argv(void);
Expand Down

0 comments on commit 9a8c306

Please sign in to comment.