Convert inline comments to documentation


[Up] [Top]

Documentation for package ‘inlinedocs’ version 2014.2.17

Help Pages

inlinedocs-package Convert inline comments to documentation
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
do.not.generate do not generate
DocLink Link documentation among related functions
DocLink-class Link documentation among related functions
documentableMeths documentableMeths
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
extra.method.docs extra method docs
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
findGeneric findGeneric
fixPackageFileNames fixPackageFileNames
forall forall
forall.parsers forall parsers
forfun forfun
forfun.parsers forfun parsers
GenHasAnyExposedMethod GenHasAnyExposedMethod
GenHasAnyMethodWithSrc GenHasAnyMethodWithSrc
GenHasSrc GenHasSrc
getKnownS3generics getKnownS3generics
getMethodName getMethodName
getMethodSrc getMethodSrc
getSource getSource
get_internal_S3_generics get internal S3 generics
get_S3_primitive_generics get S3 primitive generics
hiddenClasses hiddenClasses
inherit.docs inherit docs
inlinedocs 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
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
[-method ~~ Methods for Function '[' ~~
[-methods ~~ Methods for Function '[' ~~
[_method__listOfMethods_logical [ method listOfMethods logical