document getLinkFunction

NAMESPACE

@@ -12,6 +12,7 @@ export(getCalculations)
 export(getConfig)
 export(getDependencies)
 export(getISOlist)
+export(getLinkFunction)
 export(getLocation)
 export(getMadratGraph)
 export(getMadratInfo)

R/getLinkFunction.R

@@ -1,3 +1,12 @@
+#' getLinkFunction
+#'
+#' Returns a function that symlinks, hardlinks, or copies files and
+#' directories, depending on OS capabilities.
+#'
+#' @return A function with arguments "from" and "to" which should behave like
+#' file.symlink on all platforms.
+#' @author Pascal Sauer
+#' @export
 getLinkFunction <- function() {
   # try symlinks, if they don't work (Windows) fall back to hardlinks/junctions/copying