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.

Install the latest version of this package by entering the following in R:
install.packages("inlinedocs")
AuthorToby Dylan Hocking [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]
Date of publication2013-09-03 13:04:14
MaintainerToby Dylan Hocking <toby@sg.cs.titech.ac.jp>
LicenseGPL-2 | GPL-3
Version2013.9.3
http://inlinedocs.r-forge.r-project.org

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

Functions

apply.parsers Man page
combine Man page
combine.character Man page
combine.list Man page
combine.NULL Man page
decomment Man page
default.parsers Man page
descfile.names Man page
DocLink Man page
DocLink-class Man page
do.not.generate Man page
extra.code.docs Man page
extract.docs.file Man page
extract.docs.setClass Man page
extract.file.parse Man page
extract.xxx.chunks Man page
findGeneric Man page
fixPackageFileNames Man page
forall Man page
forall.parsers Man page
forfun Man page
forfun.parsers Man page
get_internal_S3_generics Man page
getKnownS3generics Man page
get_S3_primitive_generics Man page
getSource Man page
inlinedocs Man page
inlinedocs-package Man page
is_primitive_in_base Man page
kill.prefix.whitespace Man page
leadingS3generic Man page
lonely Man page
make.package.and.check Man page
modify.Rd.file Man page
non.descfile.names Man page
nondesc.parsers Man page
package.skeleton.dx Man page
prefix Man page
prefixed.lines Man page
print.allfun Man page
removeAliasesfrom.Rd.file Man page
replace.one Man page
save.test.result Man page
test.file Man page

Files

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

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.