inlinedocs: Convert inline comments to documentation

Generates Rd files from R source code with comments. The main features of the default syntax are that (1) docs are defined in comments near the relevant code, (2) function argument names are not repeated in comments, and (3) examples are defined in R code, not comments. It is also easy to define a new syntax.

Author
Toby Dylan Hocking [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]
Date of publication
2013-09-03 13:04:14
Maintainer
Toby Dylan Hocking <toby@sg.cs.titech.ac.jp>
License
GPL-2 | GPL-3
Version
2013.9.3
URLs

View on CRAN

Man pages

apply.parsers
apply parsers
combine
combine
combine.character
combine character
combine.list
combine list
combine.NULL
combine NULL
decomment
decomment
default.parsers
default parsers
descfile.names
descfile names
DocLink-class
Link documentation among related functions
do.not.generate
do not generate
extra.code.docs
Extract documentation from code chunks
extract.docs.file
extract docs file
extract.docs.setClass
S4 class inline documentation
extract.file.parse
File content analysis
extract.xxx.chunks
Extract documentation from a function
findGeneric
findGeneric
fixPackageFileNames
fixPackageFileNames
forall
forall
forall.parsers
forall parsers
forfun
forfun
forfun.parsers
forfun parsers
get_internal_S3_generics
get internal S3 generics
getKnownS3generics
getKnownS3generics
get_S3_primitive_generics
get S3 primitive generics
getSource
getSource
inlinedocs-package
Convert inline comments to documentation
is_primitive_in_base
is primitive in base
kill.prefix.whitespace
kill prefix whitespace
leadingS3generic
check whether function name is an S3 generic
lonely
lonely
make.package.and.check
make package and check
modify.Rd.file
modify Rd file
non.descfile.names
non descfile names
nondesc.parsers
nondesc parsers
package.skeleton.dx
Package skeleton deluxe
prefix
prefix
prefixed.lines
prefixed lines
print.allfun
print allfun
removeAliasesfrom.Rd.file
removeAliasesfrom Rd file
replace.one
replace one
save.test.result
save test result
test.file
test file

Files in this package

inlinedocs
inlinedocs/inst
inlinedocs/inst/testfiles
inlinedocs/inst/testfiles/seealso-after-return.R
inlinedocs/inst/testfiles/description-before.R
inlinedocs/inst/testfiles/softThreshExAttr.R
inlinedocs/inst/testfiles/attrExamples.R
inlinedocs/inst/testfiles/fermatExAttr.R
inlinedocs/inst/testfiles/space-before-end.R
inlinedocs/inst/testfiles/google2.R
inlinedocs/inst/testfiles/paren-ex.R
inlinedocs/inst/testfiles/percent.R
inlinedocs/inst/testfiles/apply.R
inlinedocs/inst/testfiles/fermat.R
inlinedocs/inst/testfiles/paren.R
inlinedocs/inst/testfiles/multi-paragraph-description.R
inlinedocs/inst/testfiles/accessorFunctions.R
inlinedocs/inst/testfiles/returnlist.R
inlinedocs/inst/testfiles/google.R
inlinedocs/inst/testfiles/escape.percent.R
inlinedocs/inst/testfiles/alternate.R
inlinedocs/inst/testfiles/silly.R
inlinedocs/inst/testfiles/sublogo.dendrogram.R
inlinedocs/inst/testfiles/inlinetags.R
inlinedocs/inst/testfiles/jss.R
inlinedocs/inst/CITATION
inlinedocs/inst/silly
inlinedocs/inst/silly/NAMESPACE
inlinedocs/inst/silly/R
inlinedocs/inst/silly/R/silly.R
inlinedocs/inst/silly/DESCRIPTION
inlinedocs/inst/scratch
inlinedocs/inst/scratch/inlinedocsTest
inlinedocs/inst/scratch/inlinedocsTest/R
inlinedocs/inst/scratch/inlinedocsTest/R/Test.R
inlinedocs/inst/scratch/inlinedocsTest/DESCRIPTION
inlinedocs/inst/scratch/tw_testIndent.R
inlinedocs/inst/etc
inlinedocs/inst/etc/author.from.author.R
inlinedocs/inst/etc/parseRd.R
inlinedocs/inst/etc/anne-parse.R
inlinedocs/inst/etc/tags
inlinedocs/inst/etc/tags/package.skeleton.dx.R
inlinedocs/inst/etc/tags/test.Rd
inlinedocs/inst/etc/tags/test.R
inlinedocs/inst/etc/tags/extract.docs.fun.Rd
inlinedocs/inst/etc/make.R
inlinedocs/inst/etc/default-function.R
inlinedocs/inst/etc/users.org
inlinedocs/inst/etc/minimalErrorPkg
inlinedocs/inst/etc/minimalErrorPkg/inst
inlinedocs/inst/etc/minimalErrorPkg/inst/silly
inlinedocs/inst/etc/minimalErrorPkg/inst/silly/NAMESPACE
inlinedocs/inst/etc/minimalErrorPkg/inst/silly/R
inlinedocs/inst/etc/minimalErrorPkg/inst/silly/R/silly.R
inlinedocs/inst/etc/minimalErrorPkg/inst/silly/DESCRIPTION
inlinedocs/inst/etc/minimalErrorPkg/inst/silly/man
inlinedocs/inst/etc/minimalErrorPkg/inst/silly/man/silly.example.Rd
inlinedocs/inst/etc/minimalErrorPkg/NAMESPACE
inlinedocs/inst/etc/minimalErrorPkg/R
inlinedocs/inst/etc/minimalErrorPkg/R/fun.R
inlinedocs/inst/etc/minimalErrorPkg/DESCRIPTION
inlinedocs/inst/etc/minimalErrorPkg/man
inlinedocs/inst/etc/minimalErrorPkg/man/fun.Rd
inlinedocs/inst/etc/anne.R
inlinedocs/inst/etc/inner.function
inlinedocs/inst/etc/inner.function/R
inlinedocs/inst/etc/inner.function/R/inner.function.R
inlinedocs/inst/etc/inner.function/DESCRIPTION
inlinedocs/inst/etc/inner.function/man
inlinedocs/inst/etc/inner.function/man/outer.function.Rd
inlinedocs/inst/etc/inner.function/man/inner.function-package.Rd
inlinedocs/tests
inlinedocs/tests/unit.tests.R
inlinedocs/NAMESPACE
inlinedocs/NEWS
inlinedocs/R
inlinedocs/R/utils.R
inlinedocs/R/package.skeleton.dx.R
inlinedocs/R/test.R
inlinedocs/R/parsers.R
inlinedocs/MD5
inlinedocs/DESCRIPTION
inlinedocs/man
inlinedocs/man/leadingS3generic.Rd
inlinedocs/man/descfile.names.Rd
inlinedocs/man/save.test.result.Rd
inlinedocs/man/forfun.Rd
inlinedocs/man/prefix.Rd
inlinedocs/man/combine.character.Rd
inlinedocs/man/get_internal_S3_generics.Rd
inlinedocs/man/do.not.generate.Rd
inlinedocs/man/lonely.Rd
inlinedocs/man/default.parsers.Rd
inlinedocs/man/combine.Rd
inlinedocs/man/extract.file.parse.Rd
inlinedocs/man/is_primitive_in_base.Rd
inlinedocs/man/decomment.Rd
inlinedocs/man/getKnownS3generics.Rd
inlinedocs/man/extract.xxx.chunks.Rd
inlinedocs/man/forfun.parsers.Rd
inlinedocs/man/forall.parsers.Rd
inlinedocs/man/package.skeleton.dx.Rd
inlinedocs/man/DocLink-class.Rd
inlinedocs/man/fixPackageFileNames.Rd
inlinedocs/man/non.descfile.names.Rd
inlinedocs/man/removeAliasesfrom.Rd.file.Rd
inlinedocs/man/getSource.Rd
inlinedocs/man/apply.parsers.Rd
inlinedocs/man/make.package.and.check.Rd
inlinedocs/man/combine.NULL.Rd
inlinedocs/man/kill.prefix.whitespace.Rd
inlinedocs/man/nondesc.parsers.Rd
inlinedocs/man/prefixed.lines.Rd
inlinedocs/man/extract.docs.file.Rd
inlinedocs/man/findGeneric.Rd
inlinedocs/man/combine.list.Rd
inlinedocs/man/get_S3_primitive_generics.Rd
inlinedocs/man/print.allfun.Rd
inlinedocs/man/replace.one.Rd
inlinedocs/man/modify.Rd.file.Rd
inlinedocs/man/extract.docs.setClass.Rd
inlinedocs/man/test.file.Rd
inlinedocs/man/forall.Rd
inlinedocs/man/extra.code.docs.Rd
inlinedocs/man/inlinedocs-package.Rd