update docs to put values returned + some cleaning references to priv…

…ate function with (:::)

R/aggregateResult.R

@@ -22,6 +22,9 @@
 #' @importFrom stringr str_split
 #' @importFrom stringi stri_replace_last_fixed
 #' @importFrom memuse Sys.meminfo
+#' 
+#' @return Object `list` of data.tables, each element representing one type 
+#' of element (areas, links, clusters)
 #'
 #' @export
 #' 
@@ -1417,21 +1420,22 @@ pmax.fast <- function(k,x) (x+k + abs(x-k))/2
 
 
 # From antaresFlowbased duplicated necessary
-#' Write ini file from list obtain by antaresRead:::readIniFile and modify by user
+#' Write ini file from list obtain by antaresRead::readIniFile and modify by user
 #'
-#' @param listData \code{list}, modified list obtained by antaresRead:::readIniFile.
+#' @param listData \code{list}, modified list obtained by antaresRead::readIniFile.
 #' @param pathIni \code{Character}, Path to ini file.
 #' @param overwrite logical, should file be overwritten if already exist?
 #'
 #' @examples
 #'
 #' \dontrun{
 #' pathIni <- "D:/exemple_test/settings/generaldata.ini"
-#' generalSetting <- antaresRead:::readIniFile(pathIni)
+#' generalSetting <- antaresRead::readIniFile(pathIni)
 #' generalSetting$output$synthesis <- FALSE
 #' writeIni(generalSetting, pathIni)
 #' }
 #'
+#' @keywords internal
 #'
 .writeIni <- function(listData, pathIni, overwrite = FALSE) {
   if (file.exists(pathIni)) {
@@ -2159,8 +2163,7 @@ aggregateResult_old <- function(opts, verbose = 1,
 #' @importFrom pbapply pblapply pboptions
 #' @importFrom doParallel registerDoParallel
 #'
-#' 
-#' @rdname aggregatate_mc_all_old
+#' @noRd
 #' 
 parAggregateMCall_old <- function(opts,
                                   nbcl = 8,

R/giveSize.R

@@ -8,6 +8,8 @@
 #' 
 #' @param x \code{numeric} RAM limit in Go
 #' 
+#' @return `list` (returned by [options()])
+#' 
 #' @examples
 #' \dontrun{
 #' #Set maximum ram to used to 50 Go

R/hvdcModification.R

@@ -8,6 +8,9 @@
 #' @param removeHvdcAreas \code{boolean} remove HVDC areas.
 #' @param reafectLinks \code{boolean} .
 #' 
+#' @return  Object of class "antaresDataList" is returned. 
+#' It is a list of data.tables, each element representing one type of element (areas, links, clusters)
+#' 
 #' @examples 
 #' \dontrun{
 #' 

R/ponderateMcAggregation.R

@@ -4,6 +4,9 @@
 #' @param fun \code{function} function to use
 #' @param ... \code{args} others args pass to fun
 #' 
+#' @return 
+#' Object of class "antaresDataTable". 
+#' 
 #' @examples
 #' \dontrun{
 #'   data <- readAntares(areas = 'all', mcYears = 'all')

R/setHvdcAreas.R

@@ -10,7 +10,8 @@
 #' 
 #' 
 #' 
-#' @return A list with three elements:
+#' @return  Object of class "antaresDataList" is returned. 
+#' It is a list of data.tables, each element representing one type of element (areas, links, clusters)
 #' 
 #' 
 #' @examples

R/utils_api.R

@@ -471,6 +471,10 @@ setSimulationPathAPI <- function(host, study_id, token, simulation = NULL,
 #'   list of simulation parameters returned by the function
 #'   \code{\link{setSimulationPathAPI}}
 #' @param timeout \code{numeric} API timeout (seconds). Default to 60.
+#' 
+#' @return
+#' Object of class `simOptions`, list of options used to read the data contained in the last
+#' simulation read by \code{\link{setTimeoutAPI}}.
 #'
 #' @export
 #'