Last 30 days

• Dec 19, 2009

  issue 21 (Suggested improvements) Status changed by travis.illig   -   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

  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
• Dec 19, 2009

  issue 24 (Render documentation inline with the code) commented on by travis.illig   -   I'm going to have to think about how this would work. Particularly on the class- level documentation, rendering inline could get really big - bigger than the actual XML doc in some cases. I'm also not sure what would happen when you click in it - would it switch to the XML so you could edit it? Would it stay rendered? Unfortunately, I think the ability to edit the doc *while rendered* is outside the scope of what I'll be able to deliver. I've done some spikes on that and... it's... hard. :S

  I'm going to have to think about how this would work. Particularly on the class- level documentation, rendering inline could get really big - bigger than the actual XML doc in some cases. I'm also not sure what would happen when you click in it - would it switch to the XML so you could edit it? Would it stay rendered? Unfortunately, I think the ability to edit the doc *while rendered* is outside the scope of what I'll be able to deliver. I've done some spikes on that and... it's... hard. :S
• Dec 19, 2009

  issue 24 (Render documentation inline with the code) reported by travis.illig   -   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.

  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.
• Dec 19, 2009

  issue 23 (Provide an option to show documentation for the code item th...) commented on by travis.illig   -   This may be a complementary option to issue #6 - the ability to 'pin' the documentation. Note that one of the reasons the documentation isn't rendered unless the caret is in the comment is performance. If the enhancement gets added, the default value for the option should be off.

  This may be a complementary option to issue #6 - the ability to 'pin' the documentation. Note that one of the reasons the documentation isn't rendered unless the caret is in the comment is performance. If the enhancement gets added, the default value for the option should be off.
• Dec 19, 2009

  issue 23 (Provide an option to show documentation for the code item th...) reported by travis.illig   -   There should be an option to show the rendered documentation regardless of if the caret is actually in the doc comment. For example, if in a method that has doc, it should show the method's documentation.

  There should be an option to show the rendered documentation regardless of if the caret is actually in the doc comment. For example, if in a method that has doc, it should show the method's documentation.
• Dec 19, 2009

  issue 22 (Collapsing/expanding documentation should be assignable to s...) reported by travis.illig   -   Currently you can expand/collapse documentation blocks with a context menu, but there should also be an option to use a shortcut key for these actions.

  Currently you can expand/collapse documentation blocks with a context menu, but there should also be an option to use a shortcut key for these actions.
• Dec 19, 2009

  issue 21 (Suggested improvements) commented on by wbjr4-bu...@yahoo.com   -   How do you change the type? It should not be listed as defect.

  How do you change the type? It should not be listed as defect.
• Dec 19, 2009

  issue 21 (Suggested improvements) reported by wbjr4-bu...@yahoo.com   -   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

  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

Earlier this year

• Sep 16, 2009

  issue 20 (Enumeration summaries don't appear in member table when memb...) reported by travis.illig   -   Create a sample enum, like: using System; using System.Runtime.Serialization; namespace TestNamespace { /// <summary> /// Test enumeration. /// </summary> public enum TestEnum { /// <summary> /// First member. /// </summary> MemberOne, /// <summary> /// Second member. /// </summary> [EnumMember] MemberTwo } Look at the class doc for the enumeration. In the table that lists the members, the member without the attribute ("MemberOne") will have its description correctly listed; the member with the attribute ("MemberTwo") will not. Both should have a proper description.

  Create a sample enum, like: using System; using System.Runtime.Serialization; namespace TestNamespace { /// <summary> /// Test enumeration. /// </summary> public enum TestEnum { /// <summary> /// First member. /// </summary> MemberOne, /// <summary> /// Second member. /// </summary> [EnumMember] MemberTwo } Look at the class doc for the enumeration. In the table that lists the members, the member without the attribute ("MemberOne") will have its description correctly listed; the member with the attribute ("MemberTwo") will not. Both should have a proper description.
• Aug 21, 2009

  ProductRoadmap (Major features and milestones we'd like to accomplish.) Wiki page edited by travis.illig   -   Revision r332 Restructured to make more sense.

  Revision r332 Restructured to make more sense.
• Aug 21, 2009

  issue 7 (Managed C++ or C++/CLI syntax representation wrong) Status changed by travis.illig   -   Marking this "Fixed," but it's really not "Fixed" so much as "functionality removed." It didn't appear that many CR_Documentor users were making use of the plugin in a C++ environment, and with my own lack of experience in C++ I'm unable to ensure a correct user experience with respect to the syntax preview. In the case of C++, users will now see a "[Language not supported for syntax preview]" message in the place where a syntax preview would normally be. The XML documentation will still display correctly - only the syntax preview was affected.

  Status: Fixed

  Marking this "Fixed," but it's really not "Fixed" so much as "functionality removed." It didn't appear that many CR_Documentor users were making use of the plugin in a C++ environment, and with my own lack of experience in C++ I'm unable to ensure a correct user experience with respect to the syntax preview. In the case of C++, users will now see a "[Language not supported for syntax preview]" message in the place where a syntax preview would normally be. The XML documentation will still display correctly - only the syntax preview was affected.

  Status: Fixed
• Aug 21, 2009

  issue 7 (Managed C++ or C++/CLI syntax representation wrong) Status changed by travis.illig   -  

  Status: Started

  Status: Started
• Aug 21, 2009

  r331 (Resolved issue #7 - Removed syntax preview support for C++ a...) committed by travis.illig   -   Resolved issue #7 - Removed syntax preview support for C++ as it was inaccurate and not being used. Showing 'language not supported' message for languages that are not supported.

  Resolved issue #7 - Removed syntax preview support for C++ as it was inaccurate and not being used. Showing 'language not supported' message for languages that are not supported.
• Aug 21, 2009

  r330 (Created mergepoint for pushing task changes into trunk.) committed by travis.illig   -   Created mergepoint for pushing task changes into trunk.

  Created mergepoint for pushing task changes into trunk.
• Aug 21, 2009

  r329 (Created mergepoint for bringing main codeline changes into t...) committed by travis.illig   -   Created mergepoint for bringing main codeline changes into task.

  Created mergepoint for bringing main codeline changes into task.
• Aug 21, 2009

  r328 (Removed regions.) committed by travis.illig   -   Removed regions.

  Removed regions.
• Aug 21, 2009

  r327 (Added handling for unsupported languages.) committed by travis.illig   -   Added handling for unsupported languages.

  Added handling for unsupported languages.
• Aug 21, 2009

  r326 (Added C++ documentation test solution. ) committed by travis.illig   -   Added C++ documentation test solution.

  Added C++ documentation test solution.
• Aug 21, 2009

  r325 (Ignoring generated IntelliSense file.) committed by travis.illig   -   Ignoring generated IntelliSense file.

  Ignoring generated IntelliSense file.
• Aug 21, 2009

  r324 (Added C++ documentation test solution.) committed by travis.illig   -   Added C++ documentation test solution.

  Added C++ documentation test solution.
• Aug 21, 2009

  r323 (Renaming to DocTestCS for standardization.) committed by travis.illig   -   Renaming to DocTestCS for standardization.

  Renaming to DocTestCS for standardization.
• Aug 21, 2009

  r322 (Renaming to DocTestCS for standardization.) committed by travis.illig   -   Renaming to DocTestCS for standardization.

  Renaming to DocTestCS for standardization.
• Aug 21, 2009

  r321 (Renaming to DocTestCS for standardization.) committed by travis.illig   -   Renaming to DocTestCS for standardization.

  Renaming to DocTestCS for standardization.
• Aug 21, 2009

  r320 (Renaming to DocTestCS for standardization.) committed by travis.illig   -   Renaming to DocTestCS for standardization.

  Renaming to DocTestCS for standardization.
• Aug 21, 2009

  r319 (Removed C++ syntax preview.) committed by travis.illig   -   Removed C++ syntax preview.

  Removed C++ syntax preview.
• Aug 21, 2009

  r318 (Moved DefaultValueStringDictionary into Collections namespac...) committed by travis.illig   -   Moved DefaultValueStringDictionary into Collections namespace and added tests.

  Moved DefaultValueStringDictionary into Collections namespace and added tests.
• Aug 21, 2009

  r317 (Created codeline for issue 7.) committed by travis.illig   -   Created codeline for issue 7 .

  Created codeline for issue 7 .
• Aug 21, 2009

  r316 (Created branchpoint for issue 7 codeline.) committed by travis.illig   -   Created branchpoint for issue 7 codeline.

  Created branchpoint for issue 7 codeline.
• Aug 21, 2009

  r315 (Created folder for issue 7 task tags.) committed by travis.illig   -   Created folder for issue 7 task tags.

  Created folder for issue 7 task tags.
• Aug 21, 2009

  r314 (Created folder for issue 7 source tags.) committed by travis.illig   -   Created folder for issue 7 source tags.

  Created folder for issue 7 source tags.
• Aug 21, 2009

  r313 (Created tag folder for issue 7.) committed by travis.illig   -   Created tag folder for issue 7 .

  Created tag folder for issue 7 .
• Aug 21, 2009

  r312 (Created folder for issue 7.) committed by travis.illig   -   Created folder for issue 7 .

  Created folder for issue 7 .
• Jul 09, 2009

  InstallationAndUsage (Describes how to install and use CR_Documentor) Wiki page commented on by clbunner   -   When I used the documenter, sometimes the DevExpress Options... dialog will not come up. Clicking the Settings button on the Documentor window still works. I remove CR_Documentor.dll from the plugins folder and DevExpress Options... works again.

  When I used the documenter, sometimes the DevExpress Options... dialog will not come up. Clicking the Settings button on the Documentor window still works. I remove CR_Documentor.dll from the plugins folder and DevExpress Options... works again.
• May 07, 2009

  DeveloperToolsAndDependencies (Explains what you'll need to build and modify the source cod...) Wiki page edited by travis.illig
• May 07, 2009

  KnownIssues (Known issues and potential workarounds.) Wiki page edited by travis.illig
• May 07, 2009

  issue 2 (Message logging should be abstracted) Status changed by travis.illig   -   Logging is now abstracted behind classes in the CR_Documentor.Logging namespace. Thread safety has been added via SynchronizationManager calls so logging should work regardless of the thread it's called from. Upgraded to Typemock Isolator 5.3 during the fix.

  Status: Fixed

  Logging is now abstracted behind classes in the CR_Documentor.Logging namespace. Thread safety has been added via SynchronizationManager calls so logging should work regardless of the thread it's called from. Upgraded to Typemock Isolator 5.3 during the fix.

  Status: Fixed
• May 07, 2009

  r309 (Resolved issue #2 - Abstracted logging from DXCore and added...) committed by travis.illig   -   Resolved issue #2 - Abstracted logging from DXCore and added thread safety. Includes update to Typemock Isolator 5.3.

  Resolved issue #2 - Abstracted logging from DXCore and added thread safety. Includes update to Typemock Isolator 5.3.
• May 07, 2009

  r308 (Created mergepoint for pushing task changes into main codeli...) committed by travis.illig   -   Created mergepoint for pushing task changes into main codeline.

  Created mergepoint for pushing task changes into main codeline.
• May 07, 2009

  r307 (Merged from https://cr-documentor.googlecode.com/svn/branche...) committed by travis.illig   -   Merged from https://cr-documentor.googlecode.com/svn/branches/issue/2/tags/source/branchpoint to https://cr-documentor.googlecode.com/svn/branches/issue/2/tags/source/mergepoint00 into https://cr- documentor.googlecode.com/svn/branches/issue/2/dev.

  Merged from https://cr-documentor.googlecode.com/svn/branches/issue/2/tags/source/branchpoint to https://cr-documentor.googlecode.com/svn/branches/issue/2/tags/source/mergepoint00 into https://cr- documentor.googlecode.com/svn/branches/issue/2/dev.
• May 07, 2009

  r306 (Created mergepoint for bringing main codeline changes into t...) committed by travis.illig   -   Created mergepoint for bringing main codeline changes into task.

  Created mergepoint for bringing main codeline changes into task.
• May 07, 2009

  r305 (Updated to Typemock Isolator 5.3.) committed by travis.illig   -   Updated to Typemock Isolator 5.3.

  Updated to Typemock Isolator 5.3.
• May 07, 2009

  r304 (Converted items over to use the new logging system.) committed by travis.illig   -   Converted items over to use the new logging system.

  Converted items over to use the new logging system.
• May 07, 2009

  r303 (Converted items over to use the new logging system.) committed by travis.illig   -   Converted items over to use the new logging system.

  Converted items over to use the new logging system.
• May 07, 2009

  r302 (Added usage documentation.) committed by travis.illig   -   Added usage documentation.

  Added usage documentation.
• May 05, 2009

  r301 (Implemented the LogManager for retrieving specific log imple...) committed by travis.illig   -   Implemented the LogManager for retrieving specific log implementations based on class type.

  Implemented the LogManager for retrieving specific log implementations based on class type.
• May 05, 2009

  r300 (Completed logging implementation tests.) committed by travis.illig   -   Completed logging implementation tests.

  Completed logging implementation tests.
• May 05, 2009

  r299 (Finished base logger implementation.) committed by travis.illig   -   Finished base logger implementation.

  Finished base logger implementation.
• May 05, 2009

  r298 (Added log message formatting to Enter.) committed by travis.illig   -   Added log message formatting to Enter.

  Added log message formatting to Enter.
• May 05, 2009

  r297 (Implemented Logger.Exit method.) committed by travis.illig   -   Implemented Logger.Exit method.

  Implemented Logger.Exit method.
• May 05, 2009

  issue 2 (Message logging should be abstracted) commented on by travis.illig   -   It turns out I'm doing the right thing using SynchronizationManager, but SynchronizationManager can't be used outside of a Visual Studio environment. I've figured out some test code that allows me to use Typemock Isolator to mock calls to SynchronizationManager so the tests will properly run and simulate what would actually happen in a real environment. Using Typemock Isolator's "DynamicReturnValue" functionality, I can set up a method that I'd rather call instead of SynchronizationManager.BeginInvoke like this: // The SynchronizationManager static class in DXCore can't run outside a // DXCore environment. This DynamicReturnValue method can be used to swap // calls to the SynchronizationManager for unit testing purposes. // // Note that in our version we are blocking on the wait handle so the call // finishes. This doesn't happen in real SynchronizationManager calls, but // since we're trying to test the results of the call and we don't want // to Thread.Sleep in every test while we wait, we'll just make the call // synchronously. private delegate object SynchronizationManagerMethodCall(object[] parameters); private static IAsyncResult SynchronizationManagerBeginInvoke(object[] parameters, object context) { Delegate exec = parameters[0] as Delegate; SynchronizationManagerMethodCall call = delegate(object[] callParams) { return exec.DynamicInvoke(callParams); }; object[] paramArray = parameters[1] as object[]; IAsyncResult result = call.BeginInvoke(paramArray, null, null); result.AsyncWaitHandle.WaitOne(); return result; } Then in the test setup method, we can tell Typemock Isolator to always substitute calls to SynchronizationManager.BeginInvoke with our static method: [TestInitialize] public void TestInitialize() { DynamicReturnValue beginInvoke = new DynamicReturnValue(SynchronizationManagerBeginInvoke); using (RecordExpectations recorder = RecorderManager.StartRecording()) { IAsyncResult dummyResult = SynchronizationManager.BeginInvoke(null, null); recorder.Return(beginInvoke); recorder.RepeatAlways(); } } Doing that allows us to get around the runtime requirements of SynchronizationManager and test the code that consumes it.

  It turns out I'm doing the right thing using SynchronizationManager, but SynchronizationManager can't be used outside of a Visual Studio environment. I've figured out some test code that allows me to use Typemock Isolator to mock calls to SynchronizationManager so the tests will properly run and simulate what would actually happen in a real environment. Using Typemock Isolator's "DynamicReturnValue" functionality, I can set up a method that I'd rather call instead of SynchronizationManager.BeginInvoke like this: // The SynchronizationManager static class in DXCore can't run outside a // DXCore environment. This DynamicReturnValue method can be used to swap // calls to the SynchronizationManager for unit testing purposes. // // Note that in our version we are blocking on the wait handle so the call // finishes. This doesn't happen in real SynchronizationManager calls, but // since we're trying to test the results of the call and we don't want // to Thread.Sleep in every test while we wait, we'll just make the call // synchronously. private delegate object SynchronizationManagerMethodCall(object[] parameters); private static IAsyncResult SynchronizationManagerBeginInvoke(object[] parameters, object context) { Delegate exec = parameters[0] as Delegate; SynchronizationManagerMethodCall call = delegate(object[] callParams) { return exec.DynamicInvoke(callParams); }; object[] paramArray = parameters[1] as object[]; IAsyncResult result = call.BeginInvoke(paramArray, null, null); result.AsyncWaitHandle.WaitOne(); return result; } Then in the test setup method, we can tell Typemock Isolator to always substitute calls to SynchronizationManager.BeginInvoke with our static method: [TestInitialize] public void TestInitialize() { DynamicReturnValue beginInvoke = new DynamicReturnValue(SynchronizationManagerBeginInvoke); using (RecordExpectations recorder = RecorderManager.StartRecording()) { IAsyncResult dummyResult = SynchronizationManager.BeginInvoke(null, null); recorder.Return(beginInvoke); recorder.RepeatAlways(); } } Doing that allows us to get around the runtime requirements of SynchronizationManager and test the code that consumes it.