From 0e568dd8daba19e728a1ff2d082875948d77ccde Mon Sep 17 00:00:00 2001
From: Jakob Bossek <info@jakobbossek.de>
Date: Tue, 25 Aug 2015 13:50:51 +0200
Subject: [PATCH] add man-roxygen directory and some parameter templates

---
 R/setupEvolutionaryOperators.R      | 14 ++++----------
 man-roxygen/arg_mutator.R           |  2 ++
 man-roxygen/arg_parent_selector.R   |  3 +++
 man-roxygen/arg_recombinator.R      |  2 ++
 man-roxygen/arg_survival_selector.R |  3 +++
 5 files changed, 14 insertions(+), 10 deletions(-)
 create mode 100644 man-roxygen/arg_mutator.R
 create mode 100644 man-roxygen/arg_parent_selector.R
 create mode 100644 man-roxygen/arg_recombinator.R
 create mode 100644 man-roxygen/arg_survival_selector.R

diff --git a/R/setupEvolutionaryOperators.R b/R/setupEvolutionaryOperators.R
index fb7bb1e..a2a65b2 100644
--- a/R/setupEvolutionaryOperators.R
+++ b/R/setupEvolutionaryOperators.R
@@ -14,16 +14,10 @@
 #' @param generator [\code{ecr_generator}]\cr
 #'   Generator operator of type \code{ecr_generator} for the generation of the initial
 #'   population.
-#' @param parent.selector [\code{ecr_selector}]\cr
-#'   Selection operator which implements a procedure to copy individuals from a
-#'   given population to the mating pool, i. e., allow them to become parents.
-#' @param survival.selector [\code{ecr_selector}]\cr
-#'   Selection operator which implements a procedurce to extract individuals from
-#'   a given set, which should survive and set up the next generation.
-#' @param mutator [\code{ecr_mutator}]\cr
-#'   Mutation operator of type \code{ecr_mutator}.
-#' @param recombinator [\code{ecr_recombinator}]\cr
-#'   Recombination operator of type \code{ecr_recombinator}.
+#' @template arg_parent_selector
+#' @template arg_survival_selector
+#' @template arg_mutator
+#' @template arg_recombinator
 #' @param mutator.control [\code{list}]\cr
 #'   List of evolutionary parameters for the corresponding mutation operator. See the
 #'   help pages for the mutation operators for the needed values.
diff --git a/man-roxygen/arg_mutator.R b/man-roxygen/arg_mutator.R
new file mode 100644
index 0000000..2013426
--- /dev/null
+++ b/man-roxygen/arg_mutator.R
@@ -0,0 +1,2 @@
+#' @param mutator [\code{ecr_mutator}]\cr
+#'   Mutation operator of type \code{ecr_mutator}.
diff --git a/man-roxygen/arg_parent_selector.R b/man-roxygen/arg_parent_selector.R
new file mode 100644
index 0000000..16c82c7
--- /dev/null
+++ b/man-roxygen/arg_parent_selector.R
@@ -0,0 +1,3 @@
+#' @param parent.selector [\code{ecr_selector}]\cr
+#'   Selection operator which implements a procedure to copy individuals from a
+#'   given population to the mating pool, i. e., allow them to become parents.
diff --git a/man-roxygen/arg_recombinator.R b/man-roxygen/arg_recombinator.R
new file mode 100644
index 0000000..6d88380
--- /dev/null
+++ b/man-roxygen/arg_recombinator.R
@@ -0,0 +1,2 @@
+#' @param recombinator [\code{ecr_recombinator}]\cr
+#'   Recombination operator of type \code{ecr_recombinator}.
diff --git a/man-roxygen/arg_survival_selector.R b/man-roxygen/arg_survival_selector.R
new file mode 100644
index 0000000..976bd36
--- /dev/null
+++ b/man-roxygen/arg_survival_selector.R
@@ -0,0 +1,3 @@
+#' @param survival.selector [\code{ecr_selector}]\cr
+#'   Selection operator which implements a procedurce to extract individuals from
+#'   a given set, which should survive and set up the next generation.