[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: mex function online help text
From: |
John W. Eaton |
Subject: |
Re: mex function online help text |
Date: |
Fri, 19 Nov 2010 14:11:32 -0500 |
On 19-Nov-2010, Luca Citi wrote:
| I think Dan expects octave to read the documentation form the m file because
| this is what matlab does. I found this thread for the same reason.
| Do you think it is possible to implement the same in octave?
| Octave should look for the documentation the way it does now but, in case no
| documentation is found for the mex file, also look for the shadowed m file.
| The help could warn the user about this fact with a message like:
| `myfun' is a function from the file `myfun.mex'
| which is undocumented, the following help comes form the shadowed file
`myfun.m'
There is no way to put help text in a .mex file like there is for a
.oct file.
The current development version of Octave will find the help text for
a .mex function if it is in a separate .m file.
jwe