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:
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')) |
Bug tracker:https://github.com/tdhock/inlinedocs/issues
Last updated 1 years agofrom:ef5fa9a4b0. Checks:7 OK. Indexed: yes.
Target | Result | Latest binary |
---|---|---|
Doc / Vignettes | OK | Jan 09 2025 |
R-4.5-win | OK | Jan 09 2025 |
R-4.5-linux | OK | Jan 09 2025 |
R-4.4-win | OK | Jan 09 2025 |
R-4.4-mac | OK | Jan 09 2025 |
R-4.3-win | OK | Jan 09 2025 |
R-4.3-mac | OK | Jan 09 2025 |
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: