change docType for new methods in Rd

DESCRIPTION

@@ -18,4 +18,6 @@ Imports:
     xml2,
     AzureRMR
 Roxygen: list(markdown=TRUE)
-RoxygenNote: 6.1.0
+RoxygenNote: 6.1.0.9000
+Remotes:
+    cloudyr/AzureRMR

R/add_methods.R

@@ -6,16 +6,19 @@
 #'
 #' @rdname create_storage_account
 #' @name create_storage_account
-#' @usage
+#' @aliases create_storage_account
+#' @section Usage:
+#' ```
 #' create_storage_account(name, location, kind="Storage", sku=list(name="Standard_LRS", tier="Standard"), ...)
+#' ```
+#' @section Arguments:
+#' - `name`: The name of the storage account.
+#' - `location`: The location/region in which to create the account.
+#' - `kind`: The type of account, either `"Storage"` or `"BlobStorage"`.
+#' - `sku`: The SKU. This is a named list specifying various configuration options for the account.
+#' - ... Other named arguments to pass to the [az_storage] initialization function.
 #'
-#' @param name The name of the storage account.
-#' @param location The location/region in which to create the account.
-#' @param kind The type of account, either `"Storage"` or `"BlobStorage"`.
-#' @param sku The SKU. This is a named list specifying various configuration options for the account.
-#' @param ... Other named arguments to pass to the [az_storage] initialization function.
-#'
-#' @details
+#' @section Details:
 #' This method deploys a new storage account resource, with parameters given by the arguments. A storage account can host multiple types of storage:
 #' - blob storage
 #' - file storage 
@@ -24,7 +27,7 @@
 #'
 #' Accounts created with `kind = "BlobStorage"` can only host blob and table storage, while those with `kind = "Storage"` can host all four. Currently, AzureStor provides an R interface only to blob and file storage.
 #'
-#' @return
+#' @section Value:
 #' An object of class `az_storage` representing the created storage account.
 #'
 #' @seealso
@@ -39,18 +42,20 @@ NULL
 #'
 #' @rdname get_storage_account
 #' @name get_storage_account
-#' @aliases list_storage_accounts
+#' @aliases get_storage_account list_storage_accounts
 #'
-#' @usage
+#' @section Usage:
+#' ```
 #' get_storage_account(name)
 #' list_storage_accounts()
+#' ```
+#' @section Arguments:
+#' - `name`: For `get_storage_account()`, the name of the storage account.
 #'
-#' @param name For `get_storage_account()`, the name of the storage account.
-#'
-#' @details
+#' @section Details:
 #' The `AzureRMR::az_resource_group` class has both `get_storage_account()` and `list_storage_accounts()` methods, while the `AzureRMR::az_subscription` class only has the latter.
 #'
-#' @return
+#' @section Value:
 #' For `get_storage_account()`, an object of class `az_storage` representing the storage account.
 #'
 #' For `list_storage_accounts()`, a list of such objects.
@@ -67,15 +72,18 @@ NULL
 #'
 #' @rdname delete_storage_account
 #' @name delete_storage_account
+#' @aliases delete_storage_account
 #'
-#' @usage
+#' @section Usage:
+#' ```
 #' delete_storage_account(name, confirm=TRUE, wait=FALSE)
+#' ```
+#' @section Arguments:
+#' - `name`: The name of the storage account.
+#' - `confirm`: Whether to ask for confirmation before deleting.
+#' - `wait`: Whether to wait until the deletion is complete.
 #'
-#' @param name The name of the storage account.
-#' @param confirm Whether to ask for confirmation before deleting.
-#' @param wait Whether to wait until the deletion is complete.
-#'
-#' @return
+#' @section Value:
 #' NULL on successful deletion.
 #'
 #' @seealso

man/create_storage_account.Rd

@@ -3,27 +3,27 @@
 \name{create_storage_account}
 \alias{create_storage_account}
 \title{Create Azure storage account}
-\usage{
-create_storage_account(name, location, kind="Storage", sku=list(name="Standard_LRS", tier="Standard"), ...)
-}
-\arguments{
-\item{name}{The name of the storage account.}
-
-\item{location}{The location/region in which to create the account.}
-
-\item{kind}{The type of account, either \code{"Storage"} or \code{"BlobStorage"}.}
-
-\item{sku}{The SKU. This is a named list specifying various configuration options for the account.}
-
-\item{...}{Other named arguments to pass to the \link{az_storage} initialization function.}
-}
-\value{
-An object of class \code{az_storage} representing the created storage account.
-}
 \description{
 Method for the \link[AzureRMR:az_resource_group]{AzureRMR::az_resource_group} class.
 }
-\details{
+\section{Usage}{
+\preformatted{create_storage_account(name, location, kind="Storage", sku=list(name="Standard_LRS", tier="Standard"), ...)
+}
+}
+
+\section{Arguments}{
+
+\itemize{
+\item \code{name}: The name of the storage account.
+\item \code{location}: The location/region in which to create the account.
+\item \code{kind}: The type of account, either \code{"Storage"} or \code{"BlobStorage"}.
+\item \code{sku}: The SKU. This is a named list specifying various configuration options for the account.
+\item ... Other named arguments to pass to the \link{az_storage} initialization function.
+}
+}
+
+\section{Details}{
+
 This method deploys a new storage account resource, with parameters given by the arguments. A storage account can host multiple types of storage:
 \itemize{
 \item blob storage
@@ -34,6 +34,12 @@ This method deploys a new storage account resource, with parameters given by the
 
 Accounts created with \code{kind = "BlobStorage"} can only host blob and table storage, while those with \code{kind = "Storage"} can host all four. Currently, AzureStor provides an R interface only to blob and file storage.
 }
+
+\section{Value}{
+
+An object of class \code{az_storage} representing the created storage account.
+}
+
 \seealso{
 \link{get_storage_account}, \link{delete_storage_account}, \link{az_storage},
 \href{https://docs.microsoft.com/en-us/rest/api/storagerp/}{Azure Storage Provider API reference}

man/delete_storage_account.Rd

@@ -3,22 +3,28 @@
 \name{delete_storage_account}
 \alias{delete_storage_account}
 \title{Delete an Azure storage account}
-\usage{
-delete_storage_account(name, confirm=TRUE, wait=FALSE)
-}
-\arguments{
-\item{name}{The name of the storage account.}
-
-\item{confirm}{Whether to ask for confirmation before deleting.}
-
-\item{wait}{Whether to wait until the deletion is complete.}
-}
-\value{
-NULL on successful deletion.
-}
 \description{
 Method for the \link[AzureRMR:az_resource_group]{AzureRMR::az_resource_group} class.
 }
+\section{Usage}{
+\preformatted{delete_storage_account(name, confirm=TRUE, wait=FALSE)
+}
+}
+
+\section{Arguments}{
+
+\itemize{
+\item \code{name}: The name of the storage account.
+\item \code{confirm}: Whether to ask for confirmation before deleting.
+\item \code{wait}: Whether to wait until the deletion is complete.
+}
+}
+
+\section{Value}{
+
+NULL on successful deletion.
+}
+
 \seealso{
 \link{create_storage_account}, \link{get_storage_account}, \link{az_storage},
 \href{https://docs.microsoft.com/en-us/rest/api/storagerp/}{Azure Storage Provider API reference}

man/get_storage_account.Rd

@@ -4,24 +4,34 @@
 \alias{get_storage_account}
 \alias{list_storage_accounts}
 \title{Get existing Azure storage account(s)}
-\usage{
-get_storage_account(name)
+\description{
+Methods for the \link[AzureRMR:az_resource_group]{AzureRMR::az_resource_group} and \link[AzureRMR:az_subscription]{AzureRMR::az_subscription} classes.
+}
+\section{Usage}{
+\preformatted{get_storage_account(name)
 list_storage_accounts()
 }
-\arguments{
-\item{name}{For \code{get_storage_account()}, the name of the storage account.}
 }
-\value{
+
+\section{Arguments}{
+
+\itemize{
+\item \code{name}: For \code{get_storage_account()}, the name of the storage account.
+}
+}
+
+\section{Details}{
+
+The \code{AzureRMR::az_resource_group} class has both \code{get_storage_account()} and \code{list_storage_accounts()} methods, while the \code{AzureRMR::az_subscription} class only has the latter.
+}
+
+\section{Value}{
+
 For \code{get_storage_account()}, an object of class \code{az_storage} representing the storage account.
 
 For \code{list_storage_accounts()}, a list of such objects.
 }
-\description{
-Methods for the \link[AzureRMR:az_resource_group]{AzureRMR::az_resource_group} and \link[AzureRMR:az_subscription]{AzureRMR::az_subscription} classes.
-}
-\details{
-The \code{AzureRMR::az_resource_group} class has both \code{get_storage_account()} and \code{list_storage_accounts()} methods, while the \code{AzureRMR::az_subscription} class only has the latter.
-}
+
 \seealso{
 \link{create_storage_account}, \link{delete_storage_account}, \link{az_storage},
 \href{https://docs.microsoft.com/en-us/rest/api/storagerp/}{Azure Storage Provider API reference}