rroxygen

@title Missing name in Roxygen

I have documentation for R6Class:

#' Root component that don't have parent,
#'
#' It should not be used directly, only using \code{\link{pkg::component}} function.
#'
#' @name BaseComponent
#' @importFrom R6 R6Class
#' @docType class

#' @keywords components, architecture, structure

and roxygen show warning:

Warning: [c:\projects\pkg\R\components.R:1] @title Missing name

I have no idea why it show line number 1, my code is not at line 1.

Adding @title don't change anything I keep getting this warning.

Solution

  • Warning was confusing the last line of the file had this:

    #' init extend on base battery component
BaseComponent$extend <- make.extend(BaseComponent)

    replacing #' with ## fixed the issue.