inlinedocs: Convert inline comments to documentation
Version 2014.2.17

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.

AuthorToby Dylan Hocking [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut]
Date of publication2015-04-29 11:42:12
MaintainerToby Dylan Hocking <toby@sg.cs.titech.ac.jp>
LicenseGPL-2 | GPL-3
Version2014.2.17
URL http://inlinedocs.r-forge.r-project.org
Package repositoryView on R-Forge
InstallationInstall the latest version of this package by entering the following in R:
install.packages("inlinedocs", repos="http://R-Forge.R-project.org")

Getting started

Package overview

Popular man pages

descfile.names: descfile names
DocLink-class: Link documentation among related functions
extract.xxx.chunks: Extract documentation from a function
extra.method.docs: extra method docs
fixPackageFileNames: fixPackageFileNames
getMethodName: getMethodName
getSource: getSource
See all...

All man pages Function index File listing

Man pages

allClasses: allClasses
apply.parsers: apply parsers
combine: combine
combine.character: combine character
combine.list: combine list
combine.NULL: combine NULL
CompareTrimmedNonEmptyLines: CompareTrimmedNonEmptyLines
createObjects: createObjects
decomment: decomment
default.parsers: default parsers
definition.from.source: definition from source
descfile.names: descfile names
DocLink-class: Link documentation among related functions
documentableMeths: documentableMeths
do.not.generate: do not generate
exported: exported
exportedClasses: exportedClasses
exportedDocumentableMeths: exportedDocumentableMeths
exportedFunctions: exportedFunctions
exportedGenerics: exportedGenerics
extra.class.docs: Extract documentation from code chunks
extra.code.docs: Extract documentation from code chunks
extract.docs: extract docs
extract.docs.file: extract docs file
extract.docs.setClass: S4 class inline documentation
extract.docs.setMethod: S4 mehtod inline documentation
extract.file.parse: File content analysis
extract.xxx.chunks: Extract documentation from a function
extra.method.docs: extra method docs
findGeneric: findGeneric
fixPackageFileNames: fixPackageFileNames
forall: forall
forall.parsers: forall parsers
forfun: forfun
forfun.parsers: forfun parsers
GenHasAnyExposedMethod: GenHasAnyExposedMethod
GenHasAnyMethodWithSrc: GenHasAnyMethodWithSrc
GenHasSrc: GenHasSrc
get_internal_S3_generics: get internal S3 generics
getKnownS3generics: getKnownS3generics
getMethodName: getMethodName
getMethodSrc: getMethodSrc
get_S3_primitive_generics: get S3 primitive generics
getSource: getSource
hiddenClasses: hiddenClasses
inherit.docs: inherit docs
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
manMan/default.parsers: default parsers
manMan/descfile.names: descfile names
manMan/forall.parsers: forall parsers
manMan/forfun.parsers: forfun parsers
manMan/lonely: lonely
manMan/non.descfile.names: non descfile names
manMan/nondesc.parsers: nondesc parsers
manMan/prefix: prefix
methodDocName: methodDocName
MethodHasSrc: MethodHasSrc
MethodSignatureHasOnlyExportedClasses: MethodSignatureHasOnlyExportedClasses
MethodsWithSrcRefForGen: MethodsWithSrcRefForGen
methodTable: methodTable
methSig: methSig
methSrc: methSrc
mm.examples.from.testfile: mm examples from testfile
mmPromptMethods: mmPromptMethods
modify.Rd.file: modify Rd file
non.descfile.names: non descfile names
nondesc.parsers: nondesc parsers
package.skeleton.dx: Package skeleton deluxe
pe: pe
pp: print out an
prefix: prefix
prefixed.lines: prefixed lines
print.allfun: print allfun
removeAliasesfrom.Rd.file: removeAliasesfrom Rd file
removeComma: removeComma
replace.one: replace one
rewriteSetMethodArgs: rewriteSetMethodArgs
save.test.result: save test result
sigString: sigString
test.file: test file
title.from.firstline: title from firstline
trimmedNonEmptyLines: trimmedNonEmptyLines
writeClassRdFiles: writeClassRdFiles
writeFunctionRdFiles: writeFunctionRdFiles
writeMethodRdFiles: writeMethodRdFiles
writeMethodTableRdFiles: writeMethodTableRdFiles
writePackageRdFile: writePackageRdFile
z[_method__listOfMethods_logical: [ method listOfMethods logical
z[-methods: ~~ Methods for Function '[' ~~

Functions

CompareTrimmedNonEmptyLines Man page Source code
DocLink Man page
DocLink-class Man page
GenHasAnyExposedMethod Man page Source code
GenHasAnyMethodWithSrc Man page Source code
GenHasSrc Man page Source code
MethodHasSrc Man page Source code
MethodSignatureHasOnlyExportedClasses Man page Source code
MethodsWithSrcRefForGen Man page Source code
[,listOfMethods,logical-method Man page
[-methods Man page
[_method__listOfMethods_logical Man page
allClasses Man page Source code
apply.parsers Man page Source code
combine Man page Source code
combine.NULL Man page Source code
combine.character Man page Source code
combine.list Man page Source code
createObjects Man page Source code
decomment Man page Source code
default.parsers Man page Man page
definition.from.source Man page Source code
descfile.names Man page Man page
do.not.generate Man page
documentableMeths Man page Source code
exported Man page Source code
exportedClasses Man page Source code
exportedDocumentableMeths Man page Source code
exportedFunctions Man page Source code
exportedGenerics Man page Source code
extra.class.docs Man page Source code
extra.code.docs Man page Source code
extra.method.docs Man page Source code
extract.docs Man page Source code
extract.docs.file Man page
extract.docs.setClass Man page Source code
extract.docs.setMethod Man page Source code
extract.file.parse Man page Source code
extract.xxx.chunks Man page Source code
findGeneric Man page Source code
fixPackageFileNames Man page Source code
forall Man page Source code
forall.parsers Man page Man page
forfun Man page Source code
forfun.parsers Man page Man page
getKnownS3generics Man page Source code
getMethodName Man page Source code
getMethodSrc Man page Source code
getSource Man page Source code
get_S3_primitive_generics Man page Source code
get_internal_S3_generics Man page Source code
hiddenClasses Man page Source code
inherit.docs Man page Source code
inlinedocs Man page
inlinedocs-package Man page
is_primitive_in_base Man page Source code
kill.prefix.whitespace Man page Source code
leadingS3generic Man page Source code
lineSplitter Source code
lonely Man page Man page
make.package.and.check Man page Source code
methSig Man page Source code
methSrc Man page Source code
methodDocName Man page Source code
methodTable Man page Source code
mm.examples.from.testfile Man page Source code
mmPromptMethods Man page Source code
modify.Rd.file Man page Source code
non.descfile.names Man page Man page
nondesc.parsers Man page Man page
package.skeleton.dx Man page
pe Man page Source code
pp Man page Source code
prefix Man page Man page
prefixed.lines Man page
print.allfun Man page Source code
removeAliasesfrom.Rd.file Man page Source code
removeComma Man page Source code
replace.one Man page Source code
rewriteSetMethodArgs Man page Source code
save.test.result Man page Source code
sigString Man page Source code
test.file Man page Source code
textSplitter Source code
title.from.firstline Man page Source code
trimmedNonEmptyLines Man page Source code
widthCutter Source code
writeClassRdFiles Man page Source code
writeFunctionRdFiles Man page Source code
writeMethodRdFiles Man page Source code
writeMethodTableRdFiles Man page Source code
writePackageRdFile Man page Source code

Files

DESCRIPTION
NAMESPACE
NEWS
R
R/package.skeleton.dx.R
R/parsers.R
R/test.R
R/testhelpers.R
R/utils.R
inst
inst/CITATION
inst/silly
inst/silly/DESCRIPTION
inst/silly/NAMESPACE
inst/silly/R
inst/silly/R/silly.R
inst/testfiles
inst/testfiles/Rtest.r
inst/testfiles/accessorFunctions.R
inst/testfiles/alternate.R
inst/testfiles/apply.R
inst/testfiles/attrExamples.R
inst/testfiles/csall.sh
inst/testfiles/description-before.R
inst/testfiles/escape.percent.R
inst/testfiles/fermat.R
inst/testfiles/fermatExAttr.R
inst/testfiles/fermatExAttrEmpty.R
inst/testfiles/google.R
inst/testfiles/google2.R
inst/testfiles/inlinetags.R
inst/testfiles/jss.R
inst/testfiles/lastrun
inst/testfiles/mm
inst/testfiles/mm/Itest.R
inst/testfiles/mm/cITest.sh
inst/testfiles/mm/cisall.sh
inst/testfiles/mm/continousRunner.sh
inst/testfiles/mm/findGenericsAndMethodsWithSrcrefs.R
inst/testfiles/mm/help.R
inst/testfiles/mm/isall.R
inst/testfiles/mm/isolatedTestRunner.R
inst/testfiles/mm/prolog.R
inst/testfiles/mm/runit.AddExampleCodeFromExternalTest.R
inst/testfiles/mm/runit.ClassDoc.R
inst/testfiles/mm/runit.FunctionExample.R
inst/testfiles/mm/runit.Infrastructure.R
inst/testfiles/mm/runit.MethodDoc.R
inst/testfiles/mm/runit.MethodExample.R
inst/testfiles/mm/runit.NamespaceExample.R
inst/testfiles/mm/runit.RepairUsage.R
inst/testfiles/mm/srcref.example.R
inst/testfiles/multi-paragraph-description.R
inst/testfiles/paren-ex.R
inst/testfiles/paren.R
inst/testfiles/percent.R
inst/testfiles/prolog.r
inst/testfiles/reproduce
inst/testfiles/reproduce/reproduce.R
inst/testfiles/reproduce/runit.reproduceError1.R
inst/testfiles/reproduce/runit.reproduceError2.R
inst/testfiles/returnlist.R
inst/testfiles/sall.r
inst/testfiles/seealso-after-return.R
inst/testfiles/silly.R
inst/testfiles/softThreshExAttr.R
inst/testfiles/space-before-end.R
inst/testfiles/sublogo.dendrogram.R
man
man/CompareTrimmedNonEmptyLines.Rd
man/DocLink-class.Rd
man/GenHasAnyExposedMethod.Rd
man/GenHasAnyMethodWithSrc.Rd
man/GenHasSrc.Rd
man/MethodHasSrc.Rd
man/MethodSignatureHasOnlyExportedClasses.Rd
man/MethodsWithSrcRefForGen.Rd
man/allClasses.Rd
man/apply.parsers.Rd
man/combine.NULL.Rd
man/combine.Rd
man/combine.character.Rd
man/combine.list.Rd
man/createObjects.Rd
man/decomment.Rd
man/default.parsers.Rd
man/definition.from.source.Rd
man/descfile.names.Rd
man/do.not.generate.Rd
man/documentableMeths.Rd
man/exported.Rd
man/exportedClasses.Rd
man/exportedDocumentableMeths.Rd
man/exportedFunctions.Rd
man/exportedGenerics.Rd
man/extra.class.docs.Rd
man/extra.code.docs.Rd
man/extra.method.docs.Rd
man/extract.docs.Rd
man/extract.docs.file.Rd
man/extract.docs.setClass.Rd
man/extract.docs.setMethod.Rd
man/extract.file.parse.Rd
man/extract.xxx.chunks.Rd
man/findGeneric.Rd
man/fixPackageFileNames.Rd
man/forall.Rd
man/forall.parsers.Rd
man/forfun.Rd
man/forfun.parsers.Rd
man/getKnownS3generics.Rd
man/getMethodName.Rd
man/getMethodSrc.Rd
man/getSource.Rd
man/get_S3_primitive_generics.Rd
man/get_internal_S3_generics.Rd
man/hiddenClasses.Rd
man/inherit.docs.Rd
man/inlinedocs-package.Rd
man/is_primitive_in_base.Rd
man/kill.prefix.whitespace.Rd
man/leadingS3generic.Rd
man/lonely.Rd
man/make.package.and.check.Rd
man/manMan
man/manMan/default.parsers.Rd
man/manMan/descfile.names.Rd
man/manMan/forall.parsers.Rd
man/manMan/forfun.parsers.Rd
man/manMan/lonely.Rd
man/manMan/non.descfile.names.Rd
man/manMan/nondesc.parsers.Rd
man/manMan/prefix.Rd
man/methSig.Rd
man/methSrc.Rd
man/methodDocName.Rd
man/methodTable.Rd
man/mm.examples.from.testfile.Rd
man/mmPromptMethods.Rd
man/modify.Rd.file.Rd
man/non.descfile.names.Rd
man/nondesc.parsers.Rd
man/package.skeleton.dx.Rd
man/pe.Rd
man/pp.Rd
man/prefix.Rd
man/prefixed.lines.Rd
man/print.allfun.Rd
man/removeAliasesfrom.Rd.file.Rd
man/removeComma.Rd
man/replace.one.Rd
man/rewriteSetMethodArgs.Rd
man/save.test.result.Rd
man/sigString.Rd
man/test.file.Rd
man/title.from.firstline.Rd
man/trimmedNonEmptyLines.Rd
man/writeClassRdFiles.Rd
man/writeFunctionRdFiles.Rd
man/writeMethodRdFiles.Rd
man/writeMethodTableRdFiles.Rd
man/writePackageRdFile.Rd
man/z[-methods.Rd
man/z[_method__listOfMethods_logical.Rd
tests
tests/unit.tests.R
inlinedocs documentation built on May 21, 2017, 12:27 a.m.