description

description('''parameter''') returns description text of the definition '''parameter''' using current language.

'''parameter''' can be a built-in or an user-defined variable/function/unit.


{BR}
==Syntax==

{BR}if '''parameter''' is a built-in function, constant or unit, ''description()'' returns the built-in description.

{{{{[image|built-in functions, constants and units|{UP}description%2fdescription_wiki_01.png]}}}}

{BR}if '''parameter''' is a user-defined function, variable or unit, ''description()'' returns the user-defined description.

{{{{[image|user-defined variables and functions|{UP}description%2fdescription_wiki_02.png]}}}}

{BR}if the user-defined description have multiple lines, ''description()'' returns the description in a single line string.

{{{{[image|built-in|{UP}description%2fdescription_wiki_03.png]}}}}

{BR}if the user-defined description it's not defined, ''description()'' returns an empty string or a zero value.

{{{{[image|built-in|{UP}description%2fdescription_wiki_04.png]}}}}


{BR}
==History==

* SMath [http://en.smath.info/forum/yaf_postst1369_SMath-Studio-0-94-4544--10-June-2012.aspx|0.94.4544] (stable): first relase


{BR}
==See also==

* [descriptions|descriptions]
* [Functions|Functions]
* [Built In Functions|Built-in functions]
* [User functions|User functions]
* [Units|Units]


{BR}
==References==

* description() syntax tutorial [{UP}description%2fdescription%20tutorial.zip|description tutorial.zip]