get_param_tag

This function adds the permitted values and the default value to the
description of the <code>@param</code> tag. They are added as a definition list
(<code>\describe{}</code>).

internal

Utility functions to check data, variables and conditions for
functions used in 'admiral' and 'admiral' extension packages.
Additional utility helper functions to assist developers with
maintaining documentation, testing and general upkeep of 'admiral' and
'admiral' extension packages.

Ben Straub

admiraldev

Utility Functions and Development Tools for the Admiral Package
Family

Stefan Bundfuss

Jeffrey Dickinson

Ross Farrugia

Fanny Gautier

Edoardo Mancini

Gordon Miller

Daniel Sjoberg

Stefan Thoma

F. Hoffmann-La Roche AG 

GlaxoSmithKline LLC 

get_param_tag function

<dl><dt>act_param</dt>
<dd>The content of the argument description to format
A list with three named elements is expected:<ul>
<li><code>tag</code>: The <code>@param</code> tag</li>
<li><code>permitted</code>: The permitted values</li>
<li><code>default</code>: The default value</li>
</ul></dd><dl>
<dt>Default value</dt>
<dd>none</dd></dl>
</dl>
<dt>defaults</dt>
<dd>A list of default values from the function call
<dl>
<dt>Default value</dt>
<dd>none</dd></dl></dd>

Arguments

Get the content of the @param tag — get_param_tag

<dl>

<dt>act_param</dt>
<dd>The content of the argument description to format
A list with three named elements is expected:<ul>
<li><code>tag</code>: The <code>@param</code> tag</li>
<li><code>permitted</code>: The permitted values</li>
<li><code>default</code>: The default value</li>
</ul>

<dl>
<dt>Default value</dt>
<dd>none</dd>


</dl></dd>


<dt>defaults</dt>
<dd>A list of default values from the function call
<dl>
<dt>Default value</dt>
<dd>none</dd>


</dl></dd>

</dl>

Get the content of the <code>@param</code> tag

get_param_tag: Get the content of the `@param` tag

Description

Usage

Value

Arguments