inlinedocs v2013.9.3


Monthly downloads



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.

Functions in inlinedocs

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

Last month downloads


Type Package
License GPL-2 | GPL-3
LazyLoad yes
Encoding UTF-8
Packaged 2013-09-03 07:45:07 UTC; toby
NeedsCompilation no
Repository CRAN
Date/Publication 2013-09-03 13:04:14

Include our badge in your README