Como adicionar “ajuda” -text para uma função mex?

Question

Eu estou escrevendo um mex-file Matlab. No entanto, mex-arquivos parecem ter uma séria limitação: help mexfilename não irá causar um texto de ajuda para aparecer

.

Eu poderia contornar isso escrevendo um m-file, que, finalmente, chama o arquivo mex, mas inclui ajuda, mas tem que haver uma maneira melhor.

Por outro lado, de que maneira eu poderia fazer todo o na m-arquivo, onde é muito mais conveniente fazê-lo ...

de verificação de erros

Answer 1

Eu acredito PierreBdR é certo; você criaria uma versão da sua função de m-arquivo com apenas a chamada cabeçalho e bloco de comentário, mas nenhum corpo.

Pode não ser uma má idéia para colocar a verificação de erros para as entradas no arquivo-m, em seguida, ter o m-file invocar o arquivo mex (você pode ter que dar-lhes nomes diferentes, embora). Pode ser mais simples e direta de verificar variáveis ??em MATLAB (utilizando, por exemplo, built-ins, como nargchk ) e colocá-los em um formato padrão que você pode sempre querem as entradas para a função mex ter. Muitos dos Imagem funções de processamento de caixa de ferramentas que eu olhei parecem fazer isso (formatação e verificação de dados no arquivo-m, em seguida, fazendo os cálculos caros em um arquivo MEX).

Answer 2

Você tem que criar um arquivo-m (name.m) com o mesmo nome que o seu mex-file (nome.c). Então, você coloca a declaração de função e texto de ajuda, mas nenhum corpo função. Exemplo:

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