inlinedocs v2019.12.5

0

Monthly downloads

0th

Percentile

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
test.file test file
lonely lonely
leadingS3generic check whether function name is an S3 generic
get_internal_S3_generics get internal S3 generics
extra.code.docs Extract documentation from code chunks
combine.character combine character
inlinedocs-package Convert inline comments to documentation
do.not.generate do not generate
save.test.result save test result
fake_package_env fake package env
findGeneric findGeneric
extract.docs.file extract docs file
kill.prefix.whitespace kill prefix whitespace
extract.xxx.chunks Extract documentation from a function
extract.file.parse File content analysis
is_primitive_in_base is primitive in base
forfun.parsers forfun parsers
print.allfun print allfun
prefixed.lines prefixed lines
forall.parsers forall parsers
extract.docs.setClass S4 class inline documentation
forfun forfun
fixPackageFileNames fixPackageFileNames
get_S3_primitive_generics get S3 primitive generics
forall forall
getSource getSource
whole.word whole word
non.descfile.names non descfile names
test.parsers test parsers
package.skeleton.dx Package skeleton deluxe
getKnownS3generics getKnownS3generics
prefix prefix
make.package.and.check make package and check
nondesc.parsers nondesc parsers
removeAliasesfrom.Rd.file removeAliasesfrom Rd file
replace.one replace one
modify.Rd.file modify Rd file
apply.parsers apply parsers
classic.parsers classic parsers
default.parsers default parsers
descfile.names descfile names
decomment decomment
DocLink-class Link documentation among related functions
combine.list combine list
combine combine
combine.NULL combine NULL
No Results!

Last month downloads

Details

Type Package
URL http://github.com/tdhock/inlinedocs
BugReports http://github.com/tdhock/inlinedocs/issues
License GPL-2 | GPL-3
LazyLoad yes
Encoding UTF-8
NeedsCompilation no
Packaged 2019-12-05 17:44:53 UTC; th798
Repository CRAN
Date/Publication 2019-12-05 23:30:07 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/inlinedocs)](http://www.rdocumentation.org/packages/inlinedocs)