Cómo agregar “ayuda” -text a una función-Mex?

Question

Estoy escribiendo un archivo MEX-Matlab. Sin embargo, archivos MEX parecen tener una seria limitación: help mexfilename no hará que aparezca un texto de ayuda

.

Yo podría eludir esta escribiendo un archivo-m, que en última instancia llama al MEX-archivo, sino que incluye ayuda, pero tiene que haber una mejor manera.

Por otro lado, de esa manera que pude hacer toda la comprobación de errores en el archivo-m, donde es mucho más conveniente hacerlo ...

Answer 1

Creo PierreBdR es correcto; se crearía una versión m-archivo de su función con sólo la llamada cabecera y el bloque de comentario, pero ningún cuerpo.

Puede que no sea una mala idea poner la comprobación de errores para las entradas en el archivo-m, y luego tener el archivo-m invocar el MEX-archivo (puede que tenga que darles diferentes nombres, sin embargo). Puede ser más recta hacia adelante para comprobar variables en MATLAB (utilizando, por ejemplo, muebles empotrados como nargchk ) y ponerlos en un formato estándar que siempre se puede desear las entradas de la función mex tener. Muchas de las funciones de la caja de herramientas de procesamiento de imágenes que he mirado parecen hacer esto (el formato y la comprobación de los datos en el archivo-m luego hacer los cálculos costosos en un MEX-archivo).

Answer 2

Hay que crear un archivo-m (name.m) con el mismo nombre que el archivo de Mex-(name.c). A continuación, se pone la declaración de la función y el texto de ayuda, pero ningún cuerpo de la función. Ejemplo:

function [o1,o2] = MyFct(i1,i2,i3)
% MyFct takes 3 arguments and returns 2 ...