roxygen3 (version 0.1)

writeRd: [DEV] Output to Rd files in the man directory.

Description

This function is aimed primarily at developers extending this package. You shouldn't need to use it for everyday operation.

This uses the @rdname tag to determine which file the output from each rocblock is sent to.

Usage

writeRd(object)

Arguments

object
Object to proccess, starting at a Bundle, breaking down into Blocks then individual Tags

Method signatures for generic writeRd

  • AliasesTag
  • AuthorTag
  • Block
  • Bundle
  • CommentTag
  • DebugTag
  • DescriptionTag
  • DetailsTag
  • DocTypeTag
  • ExamplesTag
  • FormatTag
  • KeywordsTag
  • NameTag
  • NoteTag
  • PackageBundle
  • ParamTag
  • ReferencesTag
  • ReturnTag
  • SectionTag
  • SeealsoTag
  • SlotTag
  • SourceTag
  • Tag
  • TagUsageTag
  • TitleTag
  • UsageTag