Tag: [DEV] Tag class

In hadley/roxygen3: In-source documentation for R

Description

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

The tag class is the base class for all roxygen3 tags. To implement a new tag, you will need to subclass this class.

Usage

  Tag()

Class hierarchy for Tag

Sub classes:

• AliasesTag

• AuthorTag

• AutoImportsTag

• ClassHierarchyTag

• ClassMethodsTag

• CollateTag

• CommentTag

• ConceptTag

• DebugTag

• DefaultExportTag

• DescriptionTag

• DetailsTag

• DevTag

• DocTypeTag

• EncodingTag

• ExamplesTag

• ExampleTag

• ExportClassTag

• ExportMethodsTag

• ExportPatternTag

• ExportTag

• FamilyTag

• FormatTag

• GenericMethodsTag

• ImportClassesFromTag

• ImportFromTag

• ImportMethodsFromTag

• ImportTag

• IncludeTag

• InheritParamsTag

• IntroTag

• KeywordsTag

• MethodTag

• NameTag

• NoRdTag

• NoteTag

• ParamTag

• RdnameTag

• ReferencesTag

• ReturnTag

• S3methodTag

• SectionTag

• SeealsoTag

• SlotTag

• AutoSlotsTag

• SourceTag

• TemplateTag

• TemplateVarTag

• TitleTag

• TagUsageTag

• UsageTag

• UseDynLibTag

Generics with methods for Tag

• defaultTag* (32 methods defined for subclasses)

• format

• getPrereqs* (7 methods defined for subclasses)

• isEmpty (1 methods defined for subclasses)

• process (14 methods defined for subclasses)

• show

• value (9 methods defined for subclasses)

• value<- (20 methods defined for subclasses)

• writeDescription (1 methods defined for subclasses)

• writeNamespace (10 methods defined for subclasses)

• writeRd (22 methods defined for subclasses)

* = methods only defined for subclasses

hadley/roxygen3 documentation built on May 17, 2019, 12:16 p.m.