[education/rkward] rkward: template improved

[Stefan Rödiger]

Git commit 9d2deb0cbee77924993d40e6372e9f2544ecd00b by Stefan Rödiger.
Committed on 20/06/2022 at 21:37.
Pushed by srodiger into branch 'master'.

template improved

M  +11   -0    rkward/RKWardroxygen2.xml

https://invent.kde.org/education/rkward/commit/9d2deb0cbee77924993d40e6372e9f2544ecd00b

diff --git a/rkward/RKWardroxygen2.xml b/rkward/RKWardroxygen2.xml
index b150bcb0..7df89d00 100644
--- a/rkward/RKWardroxygen2.xml
+++ b/rkward/RKWardroxygen2.xml
@@ -28,6 +28,10 @@ function rangeCommand(command, def) {
     }
 }
 </script>
+ <item>
+  <match>author</match>
+  <fillin>${rangeCommand("\\emph"+ braces("%%1") +" ", "italic")}</fillin>
+ </item>
  <item>
   <match>Italic</match>
   <fillin>${rangeCommand("\\emph"+ braces("%%1") +" ", "italic")}</fillin>
@@ -163,6 +167,10 @@ ${rangeCommand("cat(tabular(%%1))", "mtcars[1:5, 1:5]")}
   <match>concepts</match>
   <fillin>${rangeCommand("#' @concepts %%1 Description text", "value")}</fillin>
  </item>
+ <item>
+  <match>author</match>
+  <fillin>${rangeCommand("#' @author %%1 ", "The author")}</fillin>
+ </item>
  <item>
   <match>describeIn</match>
   <fillin>${rangeCommand("#' @describeIn %%1 Description text", "value")}</fillin>
@@ -253,7 +261,9 @@ ${rangeCommand("cat(tabular(%%1))", "mtcars[1:5, 1:5]")}
 #'
 #' Description
 #'
+#' @author Jane Doe <jane.doe@@johndoehub.com>
 #' @param x The input data
+#' @keyword return
 #' @return A dummy function that does nothing with \code{x} to show basic roxygen2 principles.
 #' @seealso [base::return()] which this function wraps.
 #' @param method one of: \cr
@@ -261,6 +271,7 @@ ${rangeCommand("cat(tabular(%%1))", "mtcars[1:5, 1:5]")}
 #' "method2" - very long text here \cr
 #' @examples
 #' myfun("Hello World")
+#' \dontrun{myfun(1:1e99) }
 myfun <- function (x, method){
   print(x)
   return(NULL)