R/unlocked/templateDoc.R

In ShashankKumbhare/paramonteR: Plain Powerful Parallel Monte Carlo Library

####################################################################################################################################
################################## template-doc ####################################################################################
# >>
#'
#' @name template
#'
#>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
#'
#' @import -----
#' @import -----
#'
#>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
#'
#' @export
#'
#>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
#'
#' @title An [`R6`] ``r className = "`<className>`"`` class for [paramonte] package usage
#'
#>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
#'
#' @description
#'
#-----------------------------------------------------------------------------------------------------------------------------------
#' \describe{\item{}{
#-----------------------------------------------------------------------------------------------------------------------------------
#'
#' The `r className` class is a child of the [``r superClassName = "`<superClassName>`"``][`r superClassName`] class.
#'
#' description intro text description intro text
#' description intro text
#'
#' \out{<hr>}}}
#'
#' \describe{\item{}{\describe{
#-----------------------------------------------------------------------------------------------------------------------------------
#' \item{**description_topic_1**}{
#-----------------------------------------------------------------------------------------------------------------------------------
#'
#' description_topic_1_text description_topic_1_text
#' description_topic_1_text
#'
#' ```
#' code code code
#' ```
#'
#'   \describe{\item{**nested_description_topic_1**}{
#'
#'   nested_description_topic_1_text nested_description_topic_1
#'   nested_description_topic_1
#'
#'   }}
#'
#' }
#'
#' \out{<hr>}
#'
#-----------------------------------------------------------------------------------------------------------------------------------
#' \item{**description_topic_2**}{
#-----------------------------------------------------------------------------------------------------------------------------------
#'
#' description_topic_2_text description_topic_2_text
#' description_topic_2_text
#'
#' ```
#' code code code
#' ```
#'   \describe{\item{**nested_description_topic_2**}{
#'
#'   nested_description_topic_2_text nested_description_topic_2
#'   nested_description_topic_2
#'
#'   }}
#'
#' }
#'
#' \out{<hr>}
#'
#-----------------------------------------------------------------------------------------------------------------------------------
#' \item{**description_topic_last**}{
#-----------------------------------------------------------------------------------------------------------------------------------
#'
#' description_topic_last_text description_topic_last_text
#' description_topic_last_text
#'
#' }
#'
#' }}}
#'
#' @section .: \out{<hr>}
#'
#>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
#'
#' @section Super class:
#'
# - \href{`r superClassNameStr`.html}{`r paste0("``paramonte``", "::", superClassName)`} -> `r className`
#'
# - [`r paste0("``paramonte::", superClassNameStr, "``")`][`r superClassName`] -> `r className`
#'
#' - [``r paste0("`paramonte::", gsub("`", "", superClassName), "`")``][`r superClassName`] -> `r className`
#'
#' - `r className` has no super class
#'
#-----------------------------------------------------------------------------------------------------------------------------------
#' @inheritSection `r superClassName` Super class
#-----------------------------------------------------------------------------------------------------------------------------------
#'
#' @section ..: \out{<hr>}
#'
#>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
#'
#' @section Public fields:
#'
#-----------------------------------------------------------------------------------------------------------------------------------
#' \describe{\item{}{\describe{\item{[`r className`] **fields**}{\describe{
#-----------------------------------------------------------------------------------------------------------------------------------
#'
#' \item{`item_1`}{
#'
#'   text text text
#'
#' }
#'
#' \item{`item_2`}{
#'
#'   text text text
#'
#' }
#'
#' }}}}}
#'
#-----------------------------------------------------------------------------------------------------------------------------------
#' @inheritSection `r superClassName` Public fields
#-----------------------------------------------------------------------------------------------------------------------------------
#'
#' @section ...: \out{<hr>}
#'
#>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
#'
#' @section Class constructor:
#'
#' ## Method `new()`
#'
#' \describe{\item{}{\describe{
#'
#' \item{**Description**}{
#'
#'   Instantiates a [`r className`] class object.
#'
#' }
#'
#' \item{**Usage**}{
#'
#'   ```
#'   <className>$new( arg_1 = something
#'                    arg_2 = something )
#'   ```
#'
#' }
#'
#' \item{**Arguments**}{\describe{
#'
#'   \item{`arg_1`}{
#'   description description description description
#'   }
#'
#'   \item{`arg_2`}{
#'   description description description description
#'   }
#'
#' }}
#'
#' \item{**Returns**}{
#'
#'   Returns a new [`r className`] class object.
#'
#' }
#'
#' }}}
#'
#' @section ....: \out{<hr>}
#'
#>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
#'
#' @section Methods:
#'
#-----------------------------------------------------------------------------------------------------------------------------------
#' \describe{\item{}{ [`r className`] **methods**
#-----------------------------------------------------------------------------------------------------------------------------------
#'
#'   - \href{#method-method1}{`r paste0(className, "$", "``method1()``")`}
#'   - \href{#method-method2}{`r paste0(className, "$", "``method2()``")`}
#'
#' }}
#'
#-----------------------------------------------------------------------------------------------------------------------------------
#' @inheritSection `r superClassName` Methods
#-----------------------------------------------------------------------------------------------------------------------------------
#'
#' @section .....: \out{<hr>}
#'
#>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
#'
#' @section Methods description:
#'
#-----------------------------------------------------------------------------------------------------------------------------------
#' \out{<a id="method-method1"></a>}
#' ## Method `method1()`
#-----------------------------------------------------------------------------------------------------------------------------------
#'
#' \describe{\item{}{\describe{
#'
#' \item{**Description**}{
#'
#'   `r getDoc()`
#'
#' }
#'
#' \item{**Usage**}{
#'
#'   ```
#'   <className>$method1( arg_1 = something,
#'                        arg_2 = something )
#'   ```
#'
#' }
#'
#' \item{**Arguments**}{\describe{
#'
#'   \item{`arg_1`}{
#'   `r getDoc()`
#'   }
#'
#'   \item{`arg_2`}{
#'   `r getDoc()`
#'   }
#'
#' }}
#'
#' \item{**Returns**}{
#'
#'   `r getDoc()`
#'   `r getDoc()`
#'
#' }
#'
#' }}}
#'
#' \out{<hr>}
#'
#-----------------------------------------------------------------------------------------------------------------------------------
#' \out{<a id="method-method1"></a>}
#' ## Method `method2()`
#-----------------------------------------------------------------------------------------------------------------------------------
#'
#' \describe{\item{}{\describe{
#'
#' \item{**Description**}{
#'
#'   `r getDoc()`
#'
#' }
#'
#' \item{**Usage**}{
#'
#'   ```
#'   <className>$method2( arg_1 = something,
#'                        arg_2 = something )
#'   ```
#'
#' }
#'
#' \item{**Arguments**}{\describe{
#'
#'   \item{`arg_1`}{
#'   `r getDoc()`
#'   }
#'
#'   \item{`arg_2`}{
#'   `r getDoc()`
#'   }
#'
#' }}
#'
#' \item{**Returns**}{
#'
#'   `r getDoc()`
#'   `r getDoc()`
#'
#' }
#'
#' }}}
#'
#' \out{<hr>}
#'
#-----------------------------------------------------------------------------------------------------------------------------------
#' @inheritSection `r superClassName` Methods description
#-----------------------------------------------------------------------------------------------------------------------------------
#'
# <<
################################## template-doc ####################################################################################
####################################################################################################################################
NULL