在 Doxygen 中隐藏方法签名

发布于 2025-01-04 16:02:31 字数 720 浏览 2 评论 0原文

我正在尝试记录一些使用 Doxygen 的 Java REST 接口,与此类似

我遇到的问题是我无法从输出中删除方法签名,因此每个部分如下所示:


Book com.place.getBook(@QueryParam("title") String title, @QueryParam("author"))

此方法返回与给定标题和作者匹配的书籍或书籍列表。

参数:

  • title - 书籍作者的标题
  • - 书籍的作者。用逗号分隔多个作者。

但我真正想要的是显示 URL 而没有方法签名:


URL: /services/book?title={title}&author={author}

这个方法返回与给定标题和作者匹配的书籍或书籍列表。

参数:

  • title - 书籍作者的标题
  • - 书籍的作者。用逗号分隔多个作者。

我想我可以使用自定义别名添加 URL 标记,但如何摆脱方法签名?

I'm trying to document some Java REST interfaces uses Doxygen, similar to this.

The problem I'm having is that I can't remove the method signature from the output, so each section looks like this:


Book com.place.getBook(@QueryParam("title") String title, @QueryParam("author"))

This method returns a book or list of books matching the given title and author.

Parameters:

  • title - The title of the book
  • author - The author(s) of the book. Separate multiple authors with commas.

But what I actually want is to display the URL and no method signature:


URL: /services/book?title={title}&author={author}

This method returns a book or list of books matching the given title and author.

Parameters:

  • title - The title of the book
  • author - The author(s) of the book. Separate multiple authors with commas.

I think I can add my URL tag using a custom alias, but how do I get rid of the method signature?

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

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文