Package: inlinedocs 2023.9.4

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.

Authors:Toby Dylan Hocking [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]

inlinedocs_2023.9.4.tar.gz
inlinedocs_2023.9.4.zip(r-4.5)inlinedocs_2023.9.4.zip(r-4.4)inlinedocs_2023.9.4.zip(r-4.3)
inlinedocs_2023.9.4.tgz(r-4.4-any)inlinedocs_2023.9.4.tgz(r-4.3-any)
inlinedocs_2023.9.4.tar.gz(r-4.5-noble)inlinedocs_2023.9.4.tar.gz(r-4.4-noble)
inlinedocs_2023.9.4.tgz(r-4.4-emscripten)inlinedocs_2023.9.4.tgz(r-4.3-emscripten)
inlinedocs.pdf |inlinedocs.html
inlinedocs/json (API)
NEWS

# Install 'inlinedocs' in R:
install.packages('inlinedocs', repos = c('https://tdhock.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/tdhock/inlinedocs/issues

On CRAN:

3.16 score 2 stars 46 scripts 1.6k downloads 45 exports 0 dependencies

Last updated 1 years agofrom:ef5fa9a4b0. Checks:OK: 7. Indexed: yes.

TargetResultDate
Doc / VignettesOKNov 10 2024
R-4.5-winOKNov 10 2024
R-4.5-linuxOKNov 10 2024
R-4.4-winOKNov 10 2024
R-4.4-macOKNov 10 2024
R-4.3-winOKNov 10 2024
R-4.3-macOKNov 10 2024

Exports:apply.parsersclassic.parserscombinecombine.charactercombine.listcombine.NULLdecommentdefault.parsersdescfile.namesdo.not.generateescape_dotsextra.code.docsextract.docs.fileextract.docs.setClassextract.file.parseextract.xxx.chunksfake_package_envfindGenericfixPackageFileNamesforallforall.parsersforfunforfun.parsersget_internal_S3_genericsget_S3_primitive_genericsgetKnownS3genericsgetSourceis_primitive_in_basekill.prefix.whitespaceleadingS3genericlonelymake.package.and.checkmodify.Rd.filenon.descfile.namesnondesc.parserspackage.skeleton.dxprefixprefixed.linesprint.allfunremoveAliasesfrom.Rd.filereplace.onesave.test.resulttest.filetest.parserswhole.word

Dependencies:

Readme and manuals

Help Manual

Help pageTopics
apply parsersapply.parsers
classic parsersclassic.parsers
combinecombine
combine charactercombine.character
combine listcombine.list
combine NULLcombine.NULL
decommentdecomment
default parsersdefault.parsers
descfile namesdescfile.names
do not generatedo.not.generate
Link documentation among related functionsDocLink DocLink-class
escape dotsescape_dots
Extract documentation from code chunksextra.code.docs
extract docs fileextract.docs.file
S4 class inline documentationextract.docs.setClass
File content analysisextract.file.parse
Extract documentation from a functionextract.xxx.chunks
fake package envfake_package_env
findGenericfindGeneric
fixPackageFileNamesfixPackageFileNames
forallforall
forall parsersforall.parsers
forfunforfun
forfun parsersforfun.parsers
get internal S3 genericsget_internal_S3_generics
get S3 primitive genericsget_S3_primitive_generics
getKnownS3genericsgetKnownS3generics
getSourcegetSource
is primitive in baseis_primitive_in_base
kill prefix whitespacekill.prefix.whitespace
check whether function name is an S3 genericleadingS3generic
lonelylonely
make package and checkmake.package.and.check
modify Rd filemodify.Rd.file
non descfile namesnon.descfile.names
nondesc parsersnondesc.parsers
Package skeleton deluxepackage.skeleton.dx
prefixprefix
prefixed linesprefixed.lines
print allfunprint.allfun
removeAliasesfrom Rd fileremoveAliasesfrom.Rd.file
replace onereplace.one
save test resultsave.test.result
test filetest.file
test parserstest.parsers
whole wordwhole.word