tests/testthat/test-srcref-comment.R

In johnmchambers/roxygen2: In-source Documentation for R

context("srcref")
roc <- rd_roclet()

test_that("Source reference is included as comment", {
  out <- roc_proc_text(roc, "
    #' @name a
    #' @docType package
    NULL")

  backref <- format(get_tag(out[[1]], "backref"))
  expect_match(backref, "^% Please edit documentation in ")
})

test_that("Explicit @backref is included as comment", {
  out <- roc_proc_text(roc, "
    #' @name a
    #' @backref back/ref.file
    #' @backref root.file
    #' @docType package
    NULL")

  backref <- format(get_tag(out[[1]], "backref"))
  expect_match(backref, "^% Please edit documentation in back/ref[.]file, [.]/root[.]file")
})