Comment ajouter « aide » -text à une fonction MEX?

Question

Je suis en train d'écrire un fichier Matlab MEX. Cependant, semblent-Mex fichiers d'avoir une sérieuse limitation: help mexfilename ne causera pas un texte d'aide apparaisse

.

Je pourrais contourner cela en écrivant un m-file, qui appelle finalement le MEX-file, mais inclut une aide, mais il doit y avoir une meilleure façon.

De l'autre côté, de cette façon que je pouvais faire tout le contrôle d'erreur dans le m-file, où il est beaucoup plus pratique de le faire ...

Answer 1

Je crois PierreBdR est juste; vous devez créer une version m-fichier de votre fonction avec juste l'appel d'en-tête et bloc de commentaires, mais pas de corps.

Il pourrait ne pas être une mauvaise idée de mettre l'erreur de contrôle pour les entrées dans le m-fichier, puis ont le m-fichier appeler le MEX-file (vous pouvez avoir à leur donner des noms différents, cependant). Il peut être plus simple pour vérifier les variables dans MATLAB (en utilisant, par exemple, built-ins comme nargchk ) et les mettre dans un format standard que vous pouvez toujours vouloir les entrées à la fonction d'avoir MEX. La plupart des fonctions de boîte à outils de traitement d'image que j'ai regardé semblent le faire (le formatage et la vérification des données dans le m-fichier puis en faisant les calculs coûteux dans un fichier MEX).

Answer 2

Vous devez créer un m-file (name.m) avec le même nom que votre MEX-file (name.c). , Vous mettez ensuite la déclaration de fonction et le texte d'aide, mais aucun corps de la fonction. Exemple:

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