1.3.5.1 Пример описания функции

В описании функции сначала указывается имя описываемой функции. В той же строке за ним следует список параметров. Имена, используемые для параметров, также используются в тексте описания.

После перечисления всех форм вызова следующей строкой приводится краткое описание функции, состоящее из одного предложения.

После краткого описания могут быть приведены сведения о входных и выходных данных, примеры использования функции, примечания об используемом алгоритме и ссылки на связанные функции.

Вот описание вымышленной функции foo:

: foo (x)

: foo (x, y)

: foo (x, y, …)

Вычесть x из y, а затем прибавить к результату все оставшиеся аргументы.

Входное значение x должно быть числовым скаляром, вектором или массивом.

Если необязательное входное значение y не указано, по умолчанию оно равно 19.

Пример:

foo (1, [3, 5], 3, 9)
     ⇒ [ 14, 16 ]
foo (5)
     ⇒ 14

В более общем случае

foo (w, x, y, ...)
≡
x - w + y + ...

См. также: bar

Предполагается, что любой параметр, имя которого содержит название типа (например, integer или matrix), имеет этот тип. Параметры с именем object могут иметь любой тип. Параметры с другими именами (например, new_file) подробно рассматриваются в описании функции. В некоторых разделах в начале описываются общие особенности параметров нескольких функций.