[education/rkward/releases/0.8.1] rkward/rbackend/rpackages: roxygenize

[Thomas Friedrichsmeier]

Git commit f064a8b0abe2d3cb919cfa44cdcdfe3dc27a0aa2 by Thomas Friedrichsmeier.
Committed on 22/04/2025 at 11:28.
Pushed by tfry into branch 'releases/0.8.1'.

roxygenize

M  +1    -1    rkward/rbackend/rpackages/rkward/DESCRIPTION
M  +1    -1    rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd
M  +9    -5    rkward/rbackend/rpackages/rkward/man/rk.menu.Rd
M  +7    -0    rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd

https://invent.kde.org/education/rkward/-/commit/f064a8b0abe2d3cb919cfa44cdcdfe3dc27a0aa2

diff --git a/rkward/rbackend/rpackages/rkward/DESCRIPTION b/rkward/rbackend/rpackages/rkward/DESCRIPTION
index 803e34f69..80ae65ce1 100755
--- a/rkward/rbackend/rpackages/rkward/DESCRIPTION
+++ b/rkward/rbackend/rpackages/rkward/DESCRIPTION
@@ -15,7 +15,7 @@ LazyLoad: yes
 Authors at R: c(person(given="Thomas", family="Friedrichsmeier", email="thomas.friedrichsmeier at kdemail.net", role=c("aut")), person(given="the RKWard", family="team",
                     email="rkward-devel at kde.org", role=c("cre","aut")))
 Version: 0.8.1
-Date: 2025-04-18
+Date: 2025-04-21
 RoxygenNote: 7.3.2
 Collate: 
     'base_overrides.R'
diff --git a/rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd b/rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd
index 261550396..ee47975ab 100644
--- a/rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd
@@ -131,7 +131,7 @@ quartz(
     \code{"nbcairo"} or \code{"dbcairo"}.  Only the first will be
     available if the system was compiled without support for
     cairographics.  The default is \code{"cairo"} where \R was built
-    using \code{pangocairo} (so not usually on macOS), otherwise
+    using \code{pangocairo} (often not the case on macOS), otherwise
     \code{"Xlib"}.}
 
 \item{antialias}{for cairo types, the type of anti-aliasing (if any)
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.menu.Rd b/rkward/rbackend/rpackages/rkward/man/rk.menu.Rd
index 90546de6d..3ace85849 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.menu.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.menu.Rd
@@ -9,7 +9,9 @@
 
 \item{label}{Label of the menu entry (character)}
 
-\item{func}{Function to call for leaf item}
+\item{func}{Function to call for leaf item. Depending on the context, this function will be called with certain named arguments, which you may or may not
+want to handle (see section Details). It is strongly recommended for this R function to include an \code{...} parameter (generally unused),
+for compatibility with future expansions.}
 }
 \value{
 \code{rk.menu()} and \code{$item()} return a handle. \code{$define() returns the handle it was given (to allow command chaining)}.
@@ -27,8 +29,7 @@ Allows to add (and subsequently remove) menu items associated to specific plain
              items in the toolbar (nesting into submenus inside a toolbar is not currently supported).
 
              To actually create a menu entry for a handle, the method \code{$define} needs to be called, specifying a label, and - for leaf items - and
-             associated R function. It is recommended that specified functions have an ignored \code{...} parameter. This will be unused, currently, but
-             might be useful for compatibility with future expansions.
+             associated R function.
 
              Adding/removing menu items is a fairly computation heavy exercise, internally, and is handled asynchronously, in the frontend. Should you need
              to remove and re-add certain elements, frequently, hiding them will be more efficient (see \code{$enable()}). Note: A disabled menu item
@@ -36,13 +37,16 @@ Allows to add (and subsequently remove) menu items associated to specific plain
 
              This interface is still somewhat experimental, and currently kept to a minimal set of functions, deliberately. Please don't hesistate to give
              us feedback on what you would like to see added. Only items defined using this mechanism can be manipulated / removed.
+}
+\details{
+
 }
 \section{Methods}{
 
 \describe{
-\item{\code{call()}}{Call the function associated with this menu item}
+\item{\code{call(...)}}{Call the function associated with this menu item}
 
-\item{\code{define(label, func)}}{(Re-)define the menu item at this path. If call is specified, this become a leaf item, associated with the given function, otherwise, a submenu is created.}
+\item{\code{define(label, func)}}{(Re-)define the menu item at this path. If call is specified, this becomes a leaf item, associated with the given function, otherwise, a submenu is created.}
 
 \item{\code{enable(enable = TRUE, show = TRUE)}}{Disable and/or hide this menu item}
 
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd b/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd
index 28531fd7d..f158731dd 100644
--- a/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd
+++ b/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd
@@ -22,6 +22,13 @@ License: \tab GPL (>= 2)\cr
 LazyLoad: \tab yes\cr
 URL: \tab https://rkward.kde.org\cr
 }
+}
+\seealso{
+Useful links:
+\itemize{
+  \item \url{https://rkward.kde.org}
+}
+
 }
 \author{
 Thomas Friedrichsmeier, Meik Michalke