head 1.7; access; symbols pkgsrc-2023Q4:1.5.0.10 pkgsrc-2023Q4-base:1.5 pkgsrc-2023Q3:1.5.0.8 pkgsrc-2023Q3-base:1.5 pkgsrc-2023Q2:1.5.0.6 pkgsrc-2023Q2-base:1.5 pkgsrc-2023Q1:1.5.0.4 pkgsrc-2023Q1-base:1.5 pkgsrc-2022Q4:1.5.0.2 pkgsrc-2022Q4-base:1.5 pkgsrc-2022Q3:1.4.0.4 pkgsrc-2022Q3-base:1.4 pkgsrc-2022Q2:1.4.0.2 pkgsrc-2022Q2-base:1.4 pkgsrc-2022Q1:1.3.0.14 pkgsrc-2022Q1-base:1.3 pkgsrc-2021Q4:1.3.0.12 pkgsrc-2021Q4-base:1.3 pkgsrc-2021Q3:1.3.0.10 pkgsrc-2021Q3-base:1.3 pkgsrc-2021Q2:1.3.0.8 pkgsrc-2021Q2-base:1.3 pkgsrc-2021Q1:1.3.0.6 pkgsrc-2021Q1-base:1.3 pkgsrc-2020Q4:1.3.0.4 pkgsrc-2020Q4-base:1.3 pkgsrc-2020Q3:1.3.0.2 pkgsrc-2020Q3-base:1.3 pkgsrc-2020Q2:1.1.0.8 pkgsrc-2020Q2-base:1.1 pkgsrc-2020Q1:1.1.0.4 pkgsrc-2020Q1-base:1.1 pkgsrc-2019Q4:1.1.0.6 pkgsrc-2019Q4-base:1.1 pkgsrc-2019Q3:1.1.0.2 pkgsrc-2019Q3-base:1.1; locks; strict; comment @# @; 1.7 date 2024.02.06.13.05.35; author mef; state Exp; branches; next 1.6; commitid DuRfuW6Ej4WLdnXE; 1.6 date 2024.01.22.23.16.31; author mef; state Exp; branches; next 1.5; commitid iZw7iYUx1Nce5vVE; 1.5 date 2022.12.18.04.51.33; author mef; state Exp; branches; next 1.4; commitid o9sPrhWWa6FjPZ5E; 1.4 date 2022.04.30.14.39.03; author mef; state Exp; branches; next 1.3; commitid qQjTJJ6nD264xeCD; 1.3 date 2020.09.24.00.44.53; author mef; state Exp; branches; next 1.2; commitid 4Ab5XoU5wFzXEepC; 1.2 date 2020.09.20.04.29.28; author mef; state Exp; branches; next 1.1; commitid 15viFyzTFDpI1KoC; 1.1 date 2019.08.09.19.12.14; author brook; state Exp; branches; next ; commitid HCJLExDPOeFR1oyB; desc @@ 1.7 log @(devel/R-roxygen2) Update 7.3.0 to 7.3.1 # roxygen2 7.3.1 * S3 method export warning no longer fails if class contains `{` or `}` (#1575). * `@@family` lists are now ordered more carefully, "foo1" comes after "foo" (#1563, @@krlmlr). * `@@importFrom` works again for quoted non-syntactic names, e.g. `@@importFrom magrittr "%>%"` or ``@@importFrom rlang `:=` `` (#1570, @@MichaelChirico). The unquoted form `@@importFrom magrittr %>%` continues to work. Relatedly, `@@importFrom` directives matching no known functions (e.g. `@@importFrom utils plot pdf`) produce valid NAMESPACE files again. * Multi-line `@@rawNamespace` no longer break re-runs of `namespace_roclet()` (#1572, @@MichaelChirico). @ text @# $NetBSD: Makefile,v 1.6 2024/01/22 23:16:31 mef Exp $ R_PKGNAME= roxygen2 R_PKGVER= 7.3.1 CATEGORIES= devel MAINTAINER= pkgsrc-users@@NetBSD.org COMMENT= In-line documentation for R LICENSE= mit DEPENDS+= R-desc>=1.2.0:../../devel/R-desc DEPENDS+= R-pkgload>=1.0.2:../../devel/R-pkgload DEPENDS+= R-purrr>=0.3.2:../../devel/R-purrr DEPENDS+= R-digest>=0.6.20:../../security/R-digest DEPENDS+= R-brew>=1.0.6:../../textproc/R-brew DEPENDS+= R-commonmark>=1.7:../../textproc/R-commonmark DEPENDS+= R-stringi>=1.4.3:../../textproc/R-stringi DEPENDS+= R-stringr>=1.0.0:../../textproc/R-stringr DEPENDS+= R-xml2>=1.2.2:../../textproc/R-xml2 DEPENDS+= R-knitr-[0-9]*:../../print/R-knitr TEST_DEPENDS+= R-R.methodsS3-[0-9]*:../../devel/R-R.methodsS3 TEST_DEPENDS+= R-R.oo-[0-9]*:../../devel/R-R.oo TEST_DEPENDS+= R-devtools-[0-9]*:../../devel/R-devtools # character coding related error TEST_DEPENDS+= R-testthat-[0-9]*:../../devel/R-testthat TEST_DEPENDS+= R-rmarkdown-[0-9]*:../../textproc/R-rmarkdown # !pdfTeX error: pdflatex (file tctt1000): Font tctt1000 at 600 not found TEST_DEPENDS+= tex-ec-[0-9]*:../../fonts/tex-ec TEST_DEPENDS+= tex-inconsolata-[0-9]*:../../fonts/tex-inconsolata TEST_DEPENDS+= tex-latex-bin-[0-9]*:../../print/tex-latex-bin TEST_DEPENDS+= tex-xkeyval-[0-9]*:../../print/tex-xkeyval TEST_DEPENDS+= tex-xkeyval-[0-9]*:../../print/tex-xkeyval TEST_DEPENDS+= tex-url-[0-9]*:../../print/tex-url USE_LANGUAGES= c c++ .include "../../math/R/Makefile.extension" .include "../../lang/R-cpp11/buildlink3.mk" .include "../../mk/bsd.pkg.mk" @ 1.6 log @(devel/R-roxygen2) Updated 7.2.3 to 7.3.0 # roxygen2 7.3.0 ## New features * `@@docType package` now works more like documenting `"_PACKAGE"`, creating a `{packagename}-package` alias and clearly suggesting that you should switch to `"_PACKAGE"` instead (#1491). * `_PACKAGE` will no longer generate an alias for your package name if a function of the same name exists (#1160). * The NAMESPACE roclet now reports if you have S3 methods that are missing an `@@export` tag. All S3 methods need to be `@@export`ed (which confusingly really registers the method) even if the generic is not. This avoids rare, but hard to debug, problems (#1175). You can suppress the warning with `@@exportS3Method NULL` (#1550). * The `NAMESPACE` roclet once again regenerates imports _before_ loading package code and parsing roxygen blocks. This has been the goal for a long time (#372), but we accidentally broke it when adding support for code execution in markdown blocks. This resolves a family of problems where you somehow bork your `NAMESPACE` and can't easily get out of it because you can't re-document the package because your code doesn't reload. ## Minor improvements and bug fixes * If you document a function from another package it is automatically imported. Additionally, if you set `@@rdname` or `@@name` you can opt out of the default `reexports` topic generation and provide your own docs (#1408). * Generate correct usage for S4 methods with non-syntactic class names. * The `ROXYGEN_PKG` env var provides the name of the package being documented (#1517). * `@@describeIn foo` now suggests that you might want `@@rdname` instead (#1493). It also gives a more informative warning if you use it with an unsupported type (#1490). * In `DESCRIPTION`, URLs containing escapes in `URL` and `BugReports` are now correctly handled (@@HenningLorenzen-ext-bayer, #1415). Authors can now have multiple email addresses (@@jmbarbone, #1487). * `escape_examples()` is now exported (#1450). * `@@exportS3Method` provides the needed metadata to generate correct usage for S3 methods, just like `@@method` (#1202). * `is_s3_generic()` now ignores non-function objects when looking for a candidate function. I believe this is closer to how R operates. * `@@import` and friends are now ignored if they try to import from the package being documented. This is useful to add self-dependencies in standalone files meant to be used in other packages (r-lib/usethis#1853). * `@@importFrom` throws a friendlier error if you try and import a non-existing functions (@@MichaelChirico, #1409). * `@@include` now gives an informative warning if you use a path that doesn't exist (#1497). * `@@inherit` can now also inherit from `@@format` (#1293). @ text @d1 1 a1 1 # $NetBSD: Makefile,v 1.5 2022/12/18 04:51:33 mef Exp $ d4 1 a4 1 R_PKGVER= 7.3.0 @ 1.5 log @(devel/R-roxygen2) Updated 7.1.2 to 7.2.3 # roxygen2 7.2.3 * roxygen2 now supports HTML blocks in markdown. They are only included in the HTML manual. They can also be produced as the output of code chunks. * Improved support for RStudio IDE. # roxygen2 7.2.2 * `@@includeRmd` calls `local_reproducible_output()` to make code run in included `.Rmd`s more consistent with other sources (#1431). * Fix duplicated argument in `roxy_block()` to avoid CRAN removal. # roxygen2 7.2.1 ## Tags * All built-in tags are now documented so that you can do (e.g.) `?"@@param"` to get a basic description of `@@param` and a pointer where to learn more (#1165). This is powered by a new `tags_list()` lists all tags defined by roxygen2 and `tags_metadata()` provides some useful information about them for use by (e.g.) IDEs (#1375). * `@@describeIn` can now be used to combine more types of functions (generics, methods and other functions) into a single topic. The resulting section organises the functions by type (#1181) and displays methods like function calls. Methods are recognized only if they extend the generic in the destination,or if the destination can heuristically be identified as a constructor. * Code evaluated in inline markdown code chunks and `@@eval`/`@@evalRd`/ `@@evalNamespace` is now evaluated in an environment designed to be more reproducible and to suppress output that won't work in Rd (e.g. turning off colour and unicode support in cli) (#1351). They now also set knitr options `comment = #>` (#1380) and `collapse = TRUE` (#1376). * `@@export` will now export both the class and constructor function when applied to expressions like `foo <- setClass("foo")` (#1216). * `@@includeRmd` now gives better feedback when it fails (#1089). ## (R)markdown * New `knitr_chunk_options` option (in the `Roxygen` entry of `DESCRIPTION` or in `man/roxygen/meta.R`) is added to the knitr chunk options that roxygen2 uses for markdown code blocks and inline code (#1390). * PDF figures are only included the PDF manual, and SVG figures are only included in the HTML manual (#1399). * You can now use alternative knitr engines in markdown code blocks (#1149). * Generated HTML for code blocks never includes "NA" for language (#1251). * Using a level 1 heading in the wrong tag now gives a more useful warning (#1374). * Fix bug interpolating the results of indented inline RMarkdown (#1353). ## Other * If you have a daily build of RStudio, the lists of changed Rd files are now clickable so you can immediately see the rendered development documentation (#1354). * R6 documentation no longer shows inherited methods if there aren't any (#1371), and only links to superclass docs if they're actually available (#1236). * Automated usage no longer mangles nbsp in default arguments (#1342). # roxygen2 7.2.0 ## New features * The NAMESPACE roclet now preserves all existing non-import directives during it's first pre-processing pass. This eliminates the "NAMESPACE has changed" messages and reduces the incidence of namespace borking (#1254). * `@@inheritParams` now only inherits exact multiparameter matches, so if you're inheriting from a function with `@@param x,y` you'll only get the parameter documentation if your function needs docs for both x and y (#950). * All warning messages have been reviewed to be more informative and actionable (#1317). `@@title` now checks for multiple paragraphs. `@@export` gives a more informative warning if it contains too many lines. (#1074). All tags warn now if only provide whitespace (#1228), and problems with the first tag in each block are reported with the correct line number (#1235). * If you have a daily build of RStudio, roxygen2 warnings will now include a clickable hyperlink that will take you directly to the problem (#1323). This technology is under active development across the IDE and the cli package but is extremely exciting. ## Minor improvements and bug fixes * roxygen2 can once again read UTF-8 paths on windows (#1277). * `@@author`s are de-duplicated in merged documentation (@@DanChaltiel, #1333). * `@@exportS3method pkg::generic` now works when `pkg::generic` isn't imported by your package (#1085). * `@@includeRmd` is now adapted to change in rmarkdown 2.12 regarding math support in `github_document()` (#1304). * `@@inherit` and friends perform less aggressive link tweaking, eliminating many spurious warnings. Additionally, when you do get a warning, you'll now always learn which topic it's coming from (#1135). Inherited `\ifelse{}{}{}` tags are now inserted correctly (without additional `{}`) (#1062). * `@@inherit` now supports inheriting "Notes" with `@@inherit pkg::fun note` (@@pat-s, #1218) * Automatic `@@usage` now correctly wraps arguments containing syntactically significant whitespace (e.g anonymous functions) (#1281) and non-syntactic values surrounded by backticks (#1257). * Markdown: * Code blocks are always wrapped in `
` even if the language is unknown (#1234). * Links with markup (e.g. ``[foo `bar`][target]``) now cause an informative warning instead of generating invalid Rd. * Curly braces in links are now escaped (#1259). * Inline R code is now powered by knitr. Where available, (knit) print methods are applied (#1179). This change alters outputs and brings roxygen in line with console and R markdown behavior. `x <- "foo"` no longer inserts anything into the resulting documentation, but `x <- "foo"; x` will. This also means that returning a character vector will insert commas between components, not newlines. * roxygen2 no longer generates invalid HTML (#1290). * DOIs, arXiv links, and urls in the `Description` field of the `DESCRIPTION` are now converted to the appropriate Rd markup (@@dieghernan, #1265, #1164). DOIs in the `URL` field of the `DESCRIPTION` are now converted to Rd's special `\doi{}` tag (@@ThierryO, #1296). @ text @d1 1 a1 1 # $NetBSD: Makefile,v 1.4 2022/04/30 14:39:03 mef Exp $ d4 1 a4 1 R_PKGVER= 7.2.3 d25 1 d29 8 @ 1.4 log @(devel/R-roxygen2) Updated 7.1.1 to 7.1.2 # roxygen2 7.1.2 * The new `@@examplesIf` tag can be used to create conditional examples. These examples only run if a specified condition holds (#962). * roxygen2 is now licensed as MIT (#1163). * Bug fix for upcoming stringr 2.0.0 release. * Code blocks with language now add `sourceCode` to the generated div; this makes syntax highlighting more consistent across downlit/pandoc/knitr/roxygen2. * Percent signs in markdown link targets, e.g. `[text](https://foo/ba%20r)` are now handled correctly (#1209). @ text @d1 1 a1 1 # $NetBSD: Makefile,v 1.3 2020/09/24 00:44:53 mef Exp $ d4 1 a4 1 R_PKGVER= 7.1.2 d22 3 a24 1 # Packages suggested but not available: 'R.methodsS3', 'R.oo' a26 1 TEST_DEPENDS+= R-devtools-[0-9]*:../../devel/R-devtools @ 1.3 log @(devel/R-roxygen2) Add missing DEPENDS @ text @d1 1 a1 1 # $NetBSD: Makefile,v 1.2 2020/09/20 04:29:28 mef Exp $ d4 1 a4 1 R_PKGVER= 7.1.1 d9 1 a9 1 LICENSE= gnu-gpl-v2 OR gnu-gpl-v3 d30 1 a30 1 .include "../../devel/R-Rcpp/buildlink3.mk" @ 1.2 log @(devel/R-roxygen) Updated 6.1.1 to 7.1.1, make test fails, missing TEST_DEPENDS # roxygen2 7.1.1 ---------------- * When processing cross package markdown links (e.g. `[pkg::fun()]`), roxygen2 now looks up the file it needs to link to, instead of linking to the topic, to avoid "Non-file package-anchored links" `R CMD check` warnings. * R6 methods and re-exported functions are always sorted in the C locale; this ensures they're always sorted the same way in every environment (#1077). * roxygen2 now supports inline markdown code and code chunks inside Rd tags. In particular in `\out{}` (#1115). # roxygen2 7.1.0 ## New features * roxygen2 now supports inline markdown code and also code chunks, using the same notation as the knitr package. For example: ```R #' This manual was generated at: `r Sys.time()`. #' ... #' `mtcars` is a data frame with `r ncol(mtcars)` columns, here #' is a summary of them: #' #' ```{r} #' summary(mtcars) #' ``` ``` See `vignette("rd-formatting")` for details. * roxygen2 now keeps using Windows (CR LF) line endings for files that already have CR LF line endings, and uses LF for new files (#989). ## Minor improvements and bug fixes * Auto-generated package documentation can now handle author ORCID comments containing full url (#1040). * Hyperlinks to R6 methods are also added in the PDF manual (#1006). * Empty annotations (alternate text) for figures added via markdown are now omitted. This caused issues when generating pkgdown web sites (#1051). * Roxygen metadata can now have a `packages` element, giving a character vector of package names to load. This makes it easier to use extension package that provide new tags for existing roclets (#1013). See `?load_options` for more details. ```yaml Roxygen: list(markdown = TRUE, packages = "roxygenlabs") ``` * `@@evalNamespace()` works again (#1022). * `@@description NULL` and `@@details NULL` no longer fail; instead, these tags are ignored, except for `@@description NULL` in package level documentation, where it can be used to suppress the auto-generated Description section (#1008). * Multiple `@@format` tags are now combined (#1015). * The warning for `@@section` titles spanning multiple lines now includes a hint that you're missing a colon (@@maelle, #994). * Can now document objects created with `delayedAssign()` by forcing evaluation at documentation time (#1041) # roxygen2 7.0.2 ---------------- * `\example{}` escaping has been improved (again!) so that special escapes within strings are correctly escaped (#990). # roxygen2 7.0.1 ---------------- * `@@includeRmd` has now an optional second argument, the top level section the included file will go to. It defaults to the details section (#970). Code chunks are now evaluated in a child of the global environment (#972). * `@@inheritParams` does a better job of munging links. Links of the form `\link[=topic]{text}` are now automatically converted to `\link[pkg:topic]{text}` when inherited from other packages (#979). Internal `has_topic()` helper has a better implementation; this means that links should no longer be munged unnecessarily (#973). * `\example{}` escaping has been considerably simplified (#967), and is now documented in `escape_example()`. * In `\usage{}`, S3/S4 methods are no longer double-escaped (#976). * Markdown tables with cells that contain multiple elements (e.g. text and code) are now rendered correctly (#985). * Markdown code blocks containing operators and other special syntax (e.g. `function`, `if`, `+`) now converted to `\code{}` not `\verb{}` (#971). # roxygen2 7.0.0 ---------------- ## New features ### New tags * `@@includeRmd {path.Rmd}` converts an `.Rmd`/`.md` file to `.Rd` and includes it in the manual page. This allows sharing text between vignettes, `README.Rmd`, and the documentation. See `vignette("rd")` for details (#902). * `@@order {n}` tag controls the order in which blocks are processed. You can use it to override the usual ordering which proceeds from the top of each file to the bottom. `@@order 1` will be processed before `@@order 2`, and before any blocks that don't have an explicit order set (#863). * `@@exportS3Method` tag allows you to generate `S3method()` namespace directives (note the different in capitalisation) (#796). Its primary use is for "delayed" method registration, which allows you to define methods for generics found in suggested packages (available in R 3.6 and greater). For example, ```R #' @@exportS3Method package::generic generic.foo <- function(x, ...) { } ``` will generate ``` S3method(package::generic, foo) ``` (See [`vctrs::s3_register()`](https://vctrs.r-lib.org/reference/s3_register.html) you need a version that works for earlier versions of R). It also has a two argument form allows you generate arbitrary `S3method()` directives: ```R #' @@exportS3Method generic class NULL ``` ``` S3method(generic, class) ``` * New `@@returns` is an alias for `@@return` (#952). @ text @d1 1 a1 1 # $NetBSD: Makefile,v 1.1 2019/08/09 19:12:14 brook Exp $ d20 1 @ 1.1 log @R-roxygen2: initial commit Generate your Rd documentation, 'NAMESPACE' file, and collation field using specially formatted comments. Writing documentation in-line with code makes it easier to keep your documentation up-to-date as your requirements change. 'Roxygen2' is inspired by the 'Doxygen' system for C++. @ text @d1 1 a1 1 # $NetBSD$ d4 1 a4 1 R_PKGVER= 6.1.1 d21 5 @