From b8edf01f767d5f7e6d1372df4fb97689d9eae0e1 Mon Sep 17 00:00:00 2001 From: trestletech Date: Wed, 19 Jul 2017 12:21:27 -0500 Subject: [PATCH] Doc endpoint. --- R/find-port.R | 1 + R/plumber-step.R | 3 +++ man/PlumberEndpoint.Rd | 14 ++++++++++++++ 3 files changed, 18 insertions(+) create mode 100644 man/PlumberEndpoint.Rd diff --git a/R/find-port.R b/R/find-port.R index 65dd6bbab..71784922c 100644 --- a/R/find-port.R +++ b/R/find-port.R @@ -4,6 +4,7 @@ portBlacklist <- c(0, 3659, 4045, 6000, 6665, 6666, 6667, 6668, 6669) #' Get a random port between 3k and 10k, excluding the blacklist. If a preferred port #' has already been registered in .globals, use that instead. +#' #' @importFrom stats runif #' @noRd getRandomPort <- function(){ port <- 0 diff --git a/R/plumber-step.R b/R/plumber-step.R index cb9f32d5c..d70a41546 100644 --- a/R/plumber-step.R +++ b/R/plumber-step.R @@ -83,6 +83,9 @@ getRelevantArgs <- function(args, plumberExpression){ args } +#' Plumber Endpoint +#' +#' Defines a terminal handler in a PLumber router. #' @export PlumberEndpoint <- R6Class( "PlumberEndpoint", diff --git a/man/PlumberEndpoint.Rd b/man/PlumberEndpoint.Rd new file mode 100644 index 000000000..54237567f --- /dev/null +++ b/man/PlumberEndpoint.Rd @@ -0,0 +1,14 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/plumber-step.R +\docType{data} +\name{PlumberEndpoint} +\alias{PlumberEndpoint} +\title{Plumber Endpoint} +\format{An object of class \code{R6ClassGenerator} of length 24.} +\usage{ +PlumberEndpoint +} +\description{ +Defines a terminal handler in a PLumber router. +} +\keyword{datasets}