Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

Documentation Options

Description

In this field, enter a description of the signal.

The description that you specify in the Signal Properties dialog box does not appear in the generated code. To add a signal description as a comment in the generated code, you must use a Simulink® signal object. For more information, see Simulink.Signal.

Document link

In the field that displays documentation for the signal, enter a MATLAB® expression. To display the documentation, click Document Link. For example, entering the expression

web(['file:///' which('foo_signal.html')])

causes the MATLAB software default Web browser to display foo_signal.html when you click the field label.

To set this property programmatically, use the programmatic port parameter DocumentLink:

% Get a handle to the block output port
% that creates the target signal.
portHandles = get_param('myModel/myBlock','portHandles');
outportHandle = portHandles.Outport;

% Set the document link.
set_param(outportHandle,'DocumentLink',...
'web([''file:///'' which(''foo_signal.html'')])')

Related Topics

Was this topic helpful?