{"id":17671368,"url":"https://github.com/nbenn/roxydocs","last_synced_at":"2025-08-11T20:12:36.136Z","repository":{"id":151137114,"uuid":"460448865","full_name":"nbenn/roxydocs","owner":"nbenn","description":null,"archived":false,"fork":false,"pushed_at":"2022-02-17T13:37:08.000Z","size":6,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T15:13:19.757Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nbenn.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-17T13:33:08.000Z","updated_at":"2022-02-17T13:34:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"a2cc847c-1111-4607-aef2-0c4a049c91a7","html_url":"https://github.com/nbenn/roxydocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nbenn/roxydocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbenn%2Froxydocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbenn%2Froxydocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbenn%2Froxydocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbenn%2Froxydocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nbenn","download_url":"https://codeload.github.com/nbenn/roxydocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbenn%2Froxydocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269948859,"owners_count":24501821,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-24T03:42:17.177Z","updated_at":"2025-08-11T20:12:36.093Z","avatar_url":"https://github.com/nbenn.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# roxydocs\n\nIn order to add documentation to [{cpp11}](https://cpp11.r-lib.org) wrapper functions, generated using [`cpp11::cpp_register()`](https://cpp11.r-lib.org/reference/cpp_register.html), this experimental package adds a [{roxygen2}](https://roxygen2.r-lib.org) tag, `@documents`, which can be used to specify one (or several) functions which are associated with an existing block of documentation.\n\nMimicking the style of documentation where functions with explicit `@rdname` tags are associated with a `NULL`-terminated dummy block as\n\n```{r, eval = FALSE}\n#' Basic arithmetic\n#'\n#' @param a,b numeric vectors.\n#' @name arith\nNULL\n\n#' @rdname arith\nadd \u003c- function(a, b) a + b\n\n#' @rdname arith\ntimes \u003c- function(a, b) a * b\n```\n\nthe `@documents` tag attempts to create identical documentation without having to rely on `@rdname` tags.\n\n```{r, eval = FALSE}\n#' Basic arithmetic\n#'\n#' @param a,b numeric scalars.\n#' @name arith\n#' @documents add\n#' @documents times\nNULL\n\nadd \u003c- function(a, b) a + b\n\ntimes \u003c- function(a, b) a * b\n```\n\n# Disclaimer\n\nThis is not intended for production use, but was only created for exploring options for documenting [{cpp11}](https://cpp11.r-lib.org) wrapper functions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnbenn%2Froxydocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnbenn%2Froxydocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnbenn%2Froxydocs/lists"}