Exponenta Banner
exponenta event banner

Сведения о построении документов в файле MEX

В этом примере показано, как документировать xtimesy Файл MEX, созданный на платформе Windows ® с помощью компилятора Microsoft ® Visual 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

Определите компилятор Си.

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-файла со сторонней библиотекой инструкции по получению и установке необходимых файлов.

Связанные темы

Документация MATLAB

Поддержка