ice icon indicating copy to clipboard operation
ice copied to clipboard

Add Parser Support for More Doc-Comment Tags

Open InsertCreativityHere opened this issue 9 months ago • 2 comments

Doxygen supports a wide range of tags in it's doc-comments. The Parser only supports a small subset:

  • @param
  • @return
  • @throws
  • @link
  • @see

We don't want to completely rewrite the Doxygen parser, but it would be nice to expand the number of tags we support. Specifically we should consider adding:

  • @remarks
  • @p
  • @c

We also discussed adding:

  • @brief But I see less of a use-case for this one.

Feel free to comment with other tags you would like to see supported by Slice, or your opinions on the above lists.

InsertCreativityHere avatar Mar 17 '25 17:03 InsertCreativityHere

It seems like we also want to add support for markdown code-fences. At least: `code`, but should we also add support for ```code``` style fences as well?

I think it would be kind of unexpected to support one but not the other, since they're very standard Markdown syntaxes.

InsertCreativityHere avatar Mar 25 '25 15:03 InsertCreativityHere

After #3962, we now have parser support for @remarks, and in the following languages:

  • [x] C++
  • [x] C#
  • [x] Java (Added in #4118)
  • [x] JavaScript (Added in #4123)
  • [x] Matlab (Added in #4140)
  • [x] Python (Added in #4122)
  • [x] Swift (Added in #4139)

InsertCreativityHere avatar May 14 '25 21:05 InsertCreativityHere

Support for @p and code-snippets were added in #4333. I think this is all the extra tags we want to add support for at the moment.

InsertCreativityHere avatar Aug 20 '25 19:08 InsertCreativityHere