From a43f3f2f4db4f02875f4d476f91396cde6a3f6de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Cs=C3=A1rdi?= Date: Fri, 3 Nov 2023 12:10:10 +0100 Subject: [PATCH] Redocument --- DESCRIPTION | 2 +- man/backend.Rd | 6 ++++-- man/backend_keyrings.Rd | 6 ++++-- man/backend_secret_service.Rd | 6 ++++-- 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 7bd4588..6fcba37 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -14,7 +14,7 @@ Description: Platform independent 'API' to access the operating system's License: MIT + file LICENSE URL: https://keyring.r-lib.org/, https://github.com/r-lib/keyring#readme BugReports: https://github.com/r-lib/keyring/issues -RoxygenNote: 7.1.2 +RoxygenNote: 7.2.3 Roxygen: list(markdown = TRUE, r6 = FALSE) Imports: assertthat, diff --git a/man/backend.Rd b/man/backend.Rd index a3095af..48ee2e1 100644 --- a/man/backend.Rd +++ b/man/backend.Rd @@ -10,7 +10,9 @@ methods. Implementing the \code{list} method is optional. Additional methods can be defined as well. } \details{ -These are the semantics of the various methods:\preformatted{get(service, username = NULL, keyring = NULL) +These are the semantics of the various methods: + +\if{html}{\out{
}}\preformatted{get(service, username = NULL, keyring = NULL) get_raw(service, username = NULL, keyring = NULL) set(service, username = NULL, keyring = NULL, prompt = "Password: ") set_with_value(service, username = NULL, password = NULL, @@ -19,7 +21,7 @@ set_with_raw_value(service, username = NULL, password = NULL, keyring = NULL) delete(service, username = NULL, keyring = NULL) list(service = NULL, keyring = NULL) -} +}\if{html}{\out{
}} What these functions do: \itemize{ diff --git a/man/backend_keyrings.Rd b/man/backend_keyrings.Rd index 056b903..cde10c4 100644 --- a/man/backend_keyrings.Rd +++ b/man/backend_keyrings.Rd @@ -13,7 +13,9 @@ inherit from this class and redefine the \code{get}, \code{set}, \code{set_with_ } \details{ See \link{backend} for the first set of methods. This is the semantics of the -keyring management methods:\preformatted{keyring_create(keyring) +keyring management methods: + +\if{html}{\out{
}}\preformatted{keyring_create(keyring) keyring_list() keyring_delete(keyring = NULL) keyring_lock(keyring = NULL) @@ -21,7 +23,7 @@ keyring_unlock(keyring = NULL, password = NULL) keyring_is_locked(keyring = NULL) keyring_default() keyring_set_default(keyring = NULL) -} +}\if{html}{\out{
}} \itemize{ \item \code{keyring_create()} creates a new keyring. \item \code{keyring_list()} lists all keyrings. diff --git a/man/backend_secret_service.Rd b/man/backend_secret_service.Rd index 2b228c3..bd98f20 100644 --- a/man/backend_secret_service.Rd +++ b/man/backend_secret_service.Rd @@ -14,8 +14,10 @@ This backend supports multiple keyrings. See \link{backend} for the documentation of the individual methods. The \code{is_available()} method checks is a Secret Service daemon is running on the system, by trying to connect to it. It returns a logical -scalar, or throws an error, depending on its argument:\preformatted{is_available = function(report_error = FALSE) -} +scalar, or throws an error, depending on its argument: + +\if{html}{\out{
}}\preformatted{is_available = function(report_error = FALSE) +}\if{html}{\out{
}} Argument: \itemize{