From bcc5305e7b023d75f455744c19464fa1b9ed54bc Mon Sep 17 00:00:00 2001
From: andres <afquinteromoreano@gmail.com>
Date: Mon, 21 Oct 2024 21:14:20 -0500
Subject: [PATCH] docs: Documents add_auth_layers

---
 Makefile               |  5 ++++-
 R/shiny.R              |  7 +++++++
 man/add_auth_layers.Rd | 21 +++++++++++++++++++++
 man/tapLock-package.Rd |  4 ++--
 4 files changed, 34 insertions(+), 3 deletions(-)
 create mode 100644 man/add_auth_layers.Rd

diff --git a/Makefile b/Makefile
index 1b883f4..1584633 100644
--- 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
index 9ec98e4..9a93762 100644
--- 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
new file mode 100644
index 0000000..40ddece
--- /dev/null
+++ b/man/add_auth_layers.Rd
@@ -0,0 +1,21 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/shiny.R
+\name{add_auth_layers}
+\alias{add_auth_layers}
+\title{Add authentication middle ware to a 'tower' object}
+\usage{
+add_auth_layers(tower, config)
+}
+\arguments{
+\item{tower}{A 'tower' object from the package 'tower'}
+
+\item{config}{An 'openid_config' object}
+}
+\value{
+A modified 'tower' object with authentication layers
+}
+\description{
+Attaches the necessary authentication layers
+to a 'tower' object. This will secure any layer added
+after.
+}
diff --git a/man/tapLock-package.Rd b/man/tapLock-package.Rd
index 15ae7f7..c8298ba 100644
--- a/man/tapLock-package.Rd
+++ b/man/tapLock-package.Rd
@@ -4,9 +4,9 @@
 \name{tapLock-package}
 \alias{tapLock}
 \alias{tapLock-package}
-\title{tapLock: Seamless Single Sign-On}
+\title{tapLock: Seamless Single Sign-On for 'shiny'}
 \description{
-Swift and seamless Single Sign-On (SSO) integration. Designed for effortless compatibility with popular Single Sign-On providers like Google and Microsoft, it streamlines authentication, enhancing both user experience and application security. Elevate your R-based projects for a simplified, unified, and secure authentication process.
+Swift and seamless Single Sign-On (SSO) integration. Designed for effortless compatibility with popular Single Sign-On providers like Google and Microsoft, it streamlines authentication, enhancing both user experience and application security. Elevate your 'shiny' applications for a simplified, unified, and secure authentication process.
 }
 \seealso{
 Useful links: