help-octave
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: mex function online help text


From: Przemek Klosowski
Subject: Re: mex function online help text
Date: Thu, 01 Apr 2010 11:39:21 -0400
User-agent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.1.8) Gecko/20100301 Fedora/3.0.3-1.fc12 Thunderbird/3.0.3

On 03/31/2010 03:23 PM, Dan McMahill wrote:
Hello,

I'm using octave-3.2.4.  I have a compiled mex function which has been
installed to:
${prefix}/libexec/octave/3.2.4/site/oct/i686-pc-linux-gnu/wcalc-1.1/
bars_calc.mex

It works.  When I run octave, bars_calc() is available as a function
and does what I expect.

However, the online help does not  work.

octave-3.2.4:1>  help bars_calc
error: help: `bars_calc' is not documented

yet I do have this file installed:
${prefix}/libexec/octave/3.2.4/site/m/wcalc-1.1/bars_calc.m

I think that if you have a .m file and an .oct file, Octave
just reads the .oct file and doesn't touch .m. You seem to believe
that the doc subsystem reads the .m files anyway---maybe I missed
something but I didn't think that's how it works. Octave's own
functions include the documentation via the DEFUN_DLD macro:

DEFUN_DLD (issparse, args, ,
  "-*- texinfo -*-\n\
@deftypefn {Loadable Function} {} issparse (@var{expr})\n\
Return 1 if the value of the expression @var{expr} is a sparse matrix.\n\
@end deftypefn")


reply via email to

[Prev in Thread] Current Thread [Next in Thread]