Doxygen 如何从通用接口中的重写方法继承文档？

发布于 2024-12-11 03:45:08 字数 486 浏览 0 评论 0原文

我有一个接口 Collection，以及一个实现该接口 Movies 实现 Collection 的类。该接口有几个用于排序的抽象方法，这些方法被 Movies 覆盖。

我想知道的是，如何让 Doxygen 使用 Movies 类中 Collection.sort() 和 Collection.safeSort() 的文档？了解这一点很有用，因为这样我就可以编写接口的文档，而不是接口的每个实现。如果我可以为重写的方法添加文档，那就太好了，但这并不是 100% 必要的。

顺便说一句，INHERIT_DOCS 设置为 YES，我相信 Doxygen 正在挣扎，因为它实现了 Collection 而不是 Collection。

原文

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

久夏青 2024-12-18 03:45:08

似乎有许多针对 doxygen 的错误与此类行为相关，请参阅以下示例：

对于解决方法，您可以使用 @copydoc 将基类中的文档引入派生类中，类似于：

/**
 * Movies
 */
public class Movies extends Collection<Movie> {
    /**
     * @copydoc Collection<T extends Item>::sort()
     *
     * Additional documentation specific to Movies::sort().
     */
    public void sort(void) { return; }
}

这将允许基类中的文档出现在派生类文档中，而无需复制它。

There appear to be a number of bugs filed against doxygen related to this type of behavior, see the following for some examples:

For a workaround, you could use @copydoc to bring the documentation in your base class in to your derived class, something like:

/**
 * Movies
 */
public class Movies extends Collection<Movie> {
    /**
     * @copydoc Collection<T extends Item>::sort()
     *
     * Additional documentation specific to Movies::sort().
     */
    public void sort(void) { return; }
}

This will allow the documentation in the base class to appear to in the derived class documentation without having to copy it.

回复收藏 0 原文

~没有更多了~