Skip to content

Commit

Permalink
fix #486 inmem help file
Browse files Browse the repository at this point in the history
  • Loading branch information
Nelson-numerical-software committed Aug 8, 2021
1 parent ded68ce commit c1fd720
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Expand Up @@ -18,6 +18,8 @@

- [#483](http://github.com/Nelson-numerical-software/nelson/issues/483): extern modules no more build if boost not available.

- [#486](http://github.com/Nelson-numerical-software/nelson/issues/486): `inmem` help was missing.

# 0.5.7 (2021-07-24)

## Features:
Expand Down
72 changes: 72 additions & 0 deletions modules/functions_manager/help/en_US/xml/inmem.xml
@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="UTF-8"?>
<xmldoc>
<copyright>SAME AS NELSON SOFTWARE</copyright>

<language>en_US</language>
<keyword>inmem</keyword>
<short_description>Names of functions, MEX-files.</short_description>

<syntax>
<syntax_item>F = inmem()</syntax_item>
<syntax_item>[F, M] = inmem()</syntax_item>
<syntax_item>F = inmem('-completenames')</syntax_item>
<syntax_item>[F, M] = inmem('-completenames')</syntax_item>

</syntax>

<param_input>

<param_input_item>
<param_name>'-completenames'</param_name>
<param_description>a string: mex function name.</param_description>
</param_input_item>
</param_input>

<param_output>
<param_output_item>
<param_name>F</param_name>
<param_description> cell array of character vectors containing the names of the macros that are loaded.</param_description>
</param_output_item>
<param_output_item>
<param_name>M</param_name>
<param_description> cell array of character vectors containing the names of the mex that are loaded.</param_description>
</param_output_item>

</param_output>

<description><p><b>inmem</b> returns cells array of names of functions and mex currently loaded.</p>
</description>
<used_function></used_function>
<bibliography></bibliography>

<examples>
<example_item>
<example_item_type>nelson</example_item_type>
<example_item_description></example_item_description>
<example_item_data><![CDATA[clear all
tand(3)
inmem()
inmem('-completenames')
]]>
</example_item_data>
</example_item>

</examples>

<see_also>
<see_also_item>
<link linkend="${memory_manager}clear">clear</link>
</see_also_item>
</see_also>

<history>
<history_item>
<history_version>1.0.0</history_version>
<history_description>initial version</history_description>
</history_item>
</history>

<authors>
<author_item>Allan CORNET</author_item>
</authors>
</xmldoc>

0 comments on commit c1fd720

Please sign in to comment.