Add some parameters' documentation and examples
Change-Id: Ib1eb1d9a98e8eae12f4c42fc4cea38c1c118a731
diff --git a/R/KorAPConnection.R b/R/KorAPConnection.R
index 4959e45..85b12e4 100644
--- a/R/KorAPConnection.R
+++ b/R/KorAPConnection.R
@@ -5,7 +5,10 @@
defaultKorAPUrl <- "https://korap.ids-mannheim.de/"
#' Connect to a KorAP server.
+#'
#' @param KorAPUrl instead of providing the query and vc string parameters, you can also simply copy a KorAP query URL from your browser and use it here (and in \code{KorAPConnection}) to provide all necessary information for the query.
+#' @param apiVersion which version of KorAP's API you want to connect to
+#' @param apiUrl url of the KorAP web service
#' @return object that contains all connection information and can be used with \code{\link{KorAPQuery}}
#'
#' @note Currently it is not possible to authenticate the client