makeWADLDocs: Create the Rd files for methods in a WADL document

In duncantl/WADL: Programmatically process Web Application Description Language documents

Create the Rd files for methods in a WADL document

Description

makeWADLDocs and the helper makeWADLDoc generate the different Rd files corresponding to groups of methods that share the same documentation. makeWADLDocs determines which methods reference the same method definition and use these references as aliases for the documentation. makeWADLDoc is used to generate the documentation

Usage

makeWADLDocs(wadl, aliases = getWADLAliases(wadl), ..., makeDoc = makeWADLDoc,
             .genericParams = GenericParameterDocumentation)

Arguments

wadl	the WADL document given as a file/URL name, parsed XML document or a WADL object.
aliases	the collection of names of method that have an id, and another named character vector mapping the names of the methods that are references and reference the methods that have an id
...	additional parameters passed on to makeDoc
makeDoc	a function that is called to make a specific Rd file. It is called with the XML node for the method definition and a character vector naming the alias functions. This is a parameter so that others can customize the way the Rd files are generated.
.genericParams	a named list of strings providing documentation for parameters in the function being documented. This is used to document parameters that occur in multiple functions, e.g. parameters we add to all functions for a particular Web Service.

Value

An object of class WADLDocumentationCollection. This is a simple list.

Author(s)

Duncan Temple Lang

See Also

writeDoc

duncantl/WADL documentation built on Nov. 23, 2023, 4:28 p.m.