use roxygen2 tags for title, description, details

Signed-off-by: SHIMA Tatsuya <[email protected]>
apache · Aug 22, 2022 · e7a375d · e7a375d
1 parent e7f11cc
commit e7a375d
Showing 1 changed file with 3 additions and 5 deletions.
diff --git a/r/R/type.R b/r/R/type.R
@@ -56,11 +56,9 @@ DataType$import_from_c <- ImportType
 INTEGER_TYPES <- as.character(outer(c("uint", "int"), c(8, 16, 32, 64), paste0))
 FLOAT_TYPES <- c("float16", "float32", "float64", "halffloat", "float", "double")
 
-#' Infer Arrow type
-#'
-#' Infer the Arrow Array type from an R object.
-#'
-#' [type()] is deprecated in favor of [infer_type()].
+#' @title Infer Arrow type
+#' @description Infer the Arrow Array type from an R object.
+#' @details [type()] is deprecated in favor of [infer_type()].
 #'
 #' @param x an R object (usually a vector) to be converted to an [Array] or
 #'   [ChunkedArray].