History | Log In     View a printable version of the current page.  
Issue Details (XML | Word | Printable)

Key: RSRP-33352
Type: New Feature New Feature
Status: Open Open
Priority: Normal Normal
Assignee: Alexander Zverev
Reporter: Erwin Derksen
Votes: 0
Watchers: 1
Operations

If you were logged in you would be able to see more operations.
ReSharper

Request: support for <inheritdoc/> documentation tag

Created: 13 Dec 06 12:31   Updated: 21 Mar 08 19:45
Component/s: PSI, Language - C#
Fix Version/s: Future Versions
Security Level: Everybody (All jira users)

Original Estimate: Unknown Remaining Estimate: Unknown Time Spent: Unknown

Build: 326


 Description  « Hide
When overriding a member, I will normally only change its internals, not the externals. So the documentation can often be re-used from the base member.
  • NDoc 2 and, in the near future, Sandcastle probably as well, support the <inheritdoc/> tag, which makes it easier to maintain the documentation as duplication can be avoided.
  • R# only offers an option to copy the documentation when inserting an override.

So I would like to see R# add support for the <inheritdoc/> tag:

  • As an option when inserting an override (Override members dialog that is displayed after "alt+ insert - override inherited member").
  • As a quickfix when displaying the warning "Method '...' is not documented" (and it is an override).
  • When showing Quick documentation (Ctrl + Q).

(Please note that <inheritdoc/> can be multi-level deep.)
(Please also note that with this request you may close 23863)



 All   Comments   Work Log   Change History      Sort Order:
There are no comments yet on this issue.