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.

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
http://inlinedocs.r-forge.r-project.org

View on R-Forge

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

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

Files

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

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.