generateS3MethodSignature: Generate S3 method signature

Description Usage Arguments Value Author(s) References Examples

View source: R/generateS3MethodSignature.R

Description

Function to create easily function signature from an S3 class

Usage

1
generateS3MethodSignature(methodName_s_1, className_s_1, argumentNames_s)

Arguments

methodName_s_1

the function/method name to consider

className_s_1

the class name to consider

argumentNames_s

the function/method argument names

Value

A single string

Author(s)

Fabien Gelineau <neonira@gmail.com>

Maintainer: Fabien Gelineau <neonira@gmail.com>

References

Refer to Writing R extensions to know more about R documentation requirements.

Examples

1
2
3
4
5
6
print(generateReference(
         list(url = 'https://neonira.github.io/offensiveProgrammingBook/',
             label = 'Offensive Programming Book')
))
# provides following result
# "Refer to \href{https://neonira.github.io/offensiveProgrammingBook/}{Offensive Programming Book}."

neonira/wyz.code.rdoc documentation built on Feb. 19, 2020, 12:47 p.m.