Export to GitHub

cr-documentor - issue #21

Suggested improvements


Posted on Dec 19, 2009 by Helpful Rhino

Thanks for creating this great plugin.

What version of the product are you using? On what operating system? 2.3.0.1 - Windows 7 64 bit

Please provide any additional information below.

Collapsing/Expanding documentation should be assignable to shorcut keys.

Documentation should be shown regardless of being in an XmlDocComment.
ie. If in a method that has doc, it should show the method's documentation. Currently I don't keep the window open because it causes me to lose flow by having to move the cursor to the comments just to see the doc. This is really bad especially if the documentation is not on screen. I should just be able to see the documentation by being in the method.

Consider showing documentation for all members when not on a specific member. This would be helpful because one could just look at the documentation instead of all the members of the class/struct/Interface...

Consider painting the formatted documentation in a compact form above the member like the sample CR_XmlDocCommentPainter that ships with CodeRush.
The CodeRush one is nice but does not handle multi-formats within the details (like <code/>). This should be available as an option or shortcut.

Again, GREAT product and thanks for your time, Wil

Comment #1

Posted on Dec 19, 2009 by Helpful Rhino

How do you change the type? It should not be listed as defect.

Comment #2

Posted on Dec 20, 2009 by Helpful Wombat

Closing this issue in favor of opening individual issues for each of the suggestions. Issue #22 is for the shortcut key idea; Issue #23 is for the render doc for the code you're in idea; Issue #24 is the rendering the preview inline idea.

I don't think I'll implement the idea to show documentation for all members when not in a specific member. If Issue #23 is implemented and the caret isn't in a method or whatever, the top-level class/interface doc would be rendered. If that wasn't the fallback - if it rendered all the XML comments in the entire file or something - there would actually be a couple of problems: * Neither Sandcastle nor NDoc render all the doc on one page, so I'd have to make something up. The goal of the plugin is to be fairly true to the doc rendering engine. * Performance would be a problem, particularly in cases where there are a lot of doc comments.

Again, thanks for the input. If you want to continue following the other issues, you'll need to mark each of them with a "star" on the issues page since I can't automatically subscribe you to them.

Status: WontFix

Labels:
Type-Defect Priority-Medium