在另请参阅文档部分中解决与内置函数的名称冲突

时间:2017-03-14 13:31:21

标签: matlab class documentation shadowing name-resolution

我有以下类,其方法是隐藏(或阴影)内置函数。我希望文档包含"另请参阅" section,链接到隐藏的内置函数。

classdef CatHelper
  %CATHELPER Makes implementing vertcat/horzcat easy on a custom class
  %
  %   See Also: cat

  methods (Abstract)
    obj = cat(obj, ndim, varargin);
  end
end

不幸的是,"另见"链接只是尝试提供有关未记录的抽象方法CatHelper/cat的帮助。

如何指定我希望该链接转到内置 cat函数?

2 个答案:

答案 0 :(得分:5)

在与doc.m\resolveTopic()玩了一下后,我提出了三个选项,如下所示。最上面的一个(\cat)给出了最好的结果,但你应该使用你认为最不模糊的情况。

%   See Also: \cat
%   See Also: elmat\cat
%   See Also: matlab\elmat\cat

通过将topic = 'cat'传递到:

找到了这些内容
matlab.internal.language.introspective.resolveName(topic, '', false);

答案 1 :(得分:0)

一个稍微丑陋的解决方法是只包含一个直接链接:

%   See Also: <a href="matlab:help cat">cat</a>