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

Question

我有以下 class，使用隐藏（或 shadows）内置函数的方法。我希望文档包含一个 "See Also" 部分，link 是隐藏的内置函数。

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

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

不幸的是，"see also" link 只是试图对未记录的抽象方法提供帮助 CatHelper/cat。

如何指定我希望 link 转到 builtin cat 函数？

Answer 1

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

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

Answer 2

在 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);

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

Resolving name clashes with builtins in a see also documentation section

documentation

matlab

class

token-name-resolution

shadowing