В этом примере показано, как документировать xtimesy Файл MEX, созданная на базе Windows® платформа с использованием Microsoft® Визуальный C++® компилятор.
Когда вы делитесь файлом MEX, пользователям нужна следующая информация о строении, используемой для создания файла MEX:
MATLAB® версия.
Создайте платформу.
Компилятор.
Скопируйте исходный файл в папку по пути MATLAB.
copyfile(fullfile(matlabroot,'extern','examples','refbook','xtimesy.c'),'.')
Создайте файл справки, xtimesy.m, и скопируйте информацию о заголовке из исходного файла.
% xtimesy.m Help file for XTIMESY MEX file % % XTIMESY Multiplies a scalar and a matrix % C = XTIMESY(b,A) multiplies scalar b with matrix A, % and returns the result in C % % MEX File function.
Идентифицируйте версию MATLAB.
v = ver('matlab');
v.Release
ans = (R2012a)
Идентифицируйте свою платформу.
archstr = computer('arch')
archstr = win64
Идентифицируйте расширение файла MEX.
ext = mexext
ext = mexw64
Идентифицируйте компилятор C.
cc = mex.getCompilerConfigurations('C','Selected'); cc.Name
ans = Microsoft Visual C++ 2008 (C)
Добавьте эту информацию в файл справки.
% xtimesy.m Help file for XTIMESY MEX file % % XTIMESY Multiplies a scalar and a matrix % C = XTIMESY(b,A) multiplies scalar b with matrix A, % and returns the result in C % % Created with: % MATLAB R2012a % Platform: win64 % Microsoft Visual C++ 2008 % MEX File function.
Предоставьте пользователям следующие сведения.
xtimesy.mexw64
xtimesy.m
Инструкции для загрузки и установки правильной библиотеки во время выполнения Microsoft Visual C++.
Если вы создаете файл MEX со сторонней библиотекой, инструкции по получению и установке необходимых файлов.