docs: Documents add_auth_layers

ixpantia · Oct 22, 2024 · bcc5305 · bcc5305
1 parent a468d8e
commit bcc5305
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 3 deletions.
diff --git a/Makefile b/Makefile
@@ -1,8 +1,11 @@
-.PHONY: install entra_id google
+.PHONY: install entra_id google document
 
 install:
 	Rscript -e "devtools::install()"
 
+document:
+	Rscript -e "devtools::document()"
+
 entra_id:
 	faucet start -w 1 -d example/entra_id
 

diff --git a/R/shiny.R b/R/shiny.R
@@ -2,6 +2,13 @@ internal_add_auth_layers <- function(config, tower) {
   UseMethod("internal_add_auth_layers")
 }
 
+#' @title Add authentication middle ware to a 'tower' object
+#' @description Attaches the necessary authentication layers
+#'   to a 'tower' object. This will secure any layer added
+#'   after.
+#' @param tower A 'tower' object from the package 'tower'
+#' @param config An 'openid_config' object
+#' @return A modified 'tower' object with authentication layers
 #' @export
 add_auth_layers <- function(tower, config) {
   internal_add_auth_layers(config, tower)

diff --git a/man/add_auth_layers.Rd b/man/add_auth_layers.Rd
diff --git a/man/tapLock-package.Rd b/man/tapLock-package.Rd