Update roxygen comment

.Rbuildignore

@@ -4,3 +4,4 @@
 ^README\.Rmd$
 ^cran-comments\.md$
 ^\.travis\.yml$
+^CRAN-RELEASE$

CRAN-RELEASE

@@ -0,0 +1,2 @@
+This package was submitted to CRAN on 2021-11-17.
+Once it is accepted, delete this file and tag the release (commit e45fd50).

R/XY.R

@@ -29,7 +29,7 @@ XY_to_mesh <- function(X, Y, size) {
 #' @param mesh A \code{mesh} class vector.
 #' @param center Should the center point of the mesh be returned? Otherwise the end points will be returned. \code{TRUE} by default.
 #'
-#' @return \code{mesh_to_XY} returns a tbl.
+#' @return \code{mesh_to_XY} returns a \code{tbl_df}.
 mesh_to_XY <- function(mesh, center = TRUE) {
   stopifnot(is_mesh(mesh))
 

R/distance.R

@@ -7,6 +7,8 @@
 #' @param type How is the NA mesh treated when \code{mesh} is a list? \code{"skip_na"} skips the \code{NA} mesh and connects the paths.
 #' \code{"keep_na"} by default.
 #'
+#' @return A double vector.
+#'
 #' @export
 mesh_distance <- function(mesh, mesh_to,
                           close = FALSE,

R/line.R

@@ -6,6 +6,8 @@
 #' @inheritParams mesh_to
 #' @param skip_na Should skip the \code{NA} mesh and connects the paths? \code{FALSE} by default.
 #'
+#' @return A list of \code{mesh} class vectors.
+#'
 #' @export
 mesh_line <- function(mesh, mesh_to,
                       close = FALSE,

R/move.R

@@ -4,6 +4,8 @@
 #' @param n_X Number of moving cells in the longitude direction.
 #' @param n_Y Number of moving cells in the latitude direction.
 #'
+#' @return A \code{mesh} class vector.
+#'
 #' @export
 mesh_move <- function(mesh, n_X, n_Y) {
   stopifnot(is_mesh(mesh))
@@ -20,6 +22,8 @@ mesh_move <- function(mesh, n_X, n_Y) {
 #' @param moore Moore neighborhood (\code{TRUE}) or Von Neumann neighborhood (\code{FALSE}).
 #' @param simplify Should simplify the format of the return?
 #'
+#' @return A list of \code{mesh} class vectors.
+#'
 #' @export
 mesh_neighbor <- function(mesh,
                           n = 1L,

R/sfc.R

@@ -3,6 +3,8 @@
 #' @param point A \code{sfc_POINT} vector.
 #' @inheritParams size
 #'
+#' @return A \code{mesh} class vector.
+#'
 #' @export
 point_to_mesh <- function(point, size) {
   stopifnot(inherits(point, "sfc_POINT"))
@@ -22,6 +24,9 @@ point_to_mesh <- function(point, size) {
 #'
 #' @inheritParams mesh
 #' @param crs Coordinate reference system.
+#'
+#' @return \code{mesh_to_polygon} returns a \code{sfc_POLYGON} vector.
+#' \code{mesh_to_point} returns a \code{sfc_POINT} vector.
 NULL
 
 mesh_to_sfc <- function(mesh,