R/tag-doctype.r

In hadley/roxygen3: In-source documentation for R

#' @@docType: set the documentation type of the object.
#'
#' Roxygen3 will guess the doctype for you - the only time you should need to
#' specify it yourself for package documentation (\code{@@docType package})
#' which typically document the code \code{NULL}.
#'
#' @details You can use any doctype, but it will only be included in
#'   the Rd file if it is one of the standard R doctypes: data, package,
#'   methods and class.
#'
#' @tagUsage
#'   @@docType data
#'   @@docType package
#'   @@docType custom doctype
#'
setClass("DocTypeTag", contains = "Tag")

setMethod("defaultTag", c("DocTypeTag", "S4MethodObject"),
  function(tag, object) {
    new("DocTypeTag", text = "methods")
  }
)
setMethod("defaultTag", c("DocTypeTag", "S4ClassObject"),
  function(tag, object) {
    new("DocTypeTag", text = "class")
  }
)
setMethod("defaultTag", c("DocTypeTag", "DataObject"),
  function(tag, object) {
    new("DocTypeTag", text = "data")
  }
)
setMethod("defaultTag", c("DocTypeTag", "R5ClassObject"),
  function(tag, object) {
    new("DocTypeTag", text = "class")
  }
)
setMethod("defaultTag", c("DocTypeTag", "PackageObject"),
  function(tag, object) {
    new("DocTypeTag", text = "package")
  }
)

setMethod("writeRd", "DocTypeTag", function(object) {
  RdCommand("docType", object@text)
})