Introduction

There are a few known issues with CR_Documentor. Many have workarounds, but some are with external systems CR_Documentor can't control. Those items that are planned to be fixed should be filed in the issue tracker and/or are on the ProductRoadmap. Also check the FrequentlyAskedQuestions page if you find you're having trouble.

The CR_Documentor window doesn't appear.

That is, when you try to open the CR_Documentor window, it doesn't show up. This usually means that the internal web server wasn't allowed to start. You can look in your DXCore logs and see the error information. It may mean you don't have permissions (if you're running Visual Studio as a non-admin user, this may be the case) or it may be something else.

There is a page describing the various ServerStartupErrors as well as workarounds where available.

The CR_Documentor window may not update as "real-time" as you would expect.

This is because it relies on the DXCore parser, which only updates during editor "idle time," and only under certain settings. That's why there's no manual "refresh" option - what you see in CR_Documentor is always the latest that has been made available for preview. There are two possible workarounds to get an updated view:

• Workaround 1: Save the document. This causes DXCore to re-parse the document and provide a new set of information to CR_Documentor, which will update the preview.
• Workaround 2: Change the frequency of document parsing. If you work with large documents (or a lot of small documents) simultaneously, this may slow things down a little, but it will provide more frequent updates in the preview window and with other DXCore plugins. To do this:
1. In Visual Studio, from the DevExpress menu, select "Options."
2. In the bottom-left corner of the Options window, make sure "Expert" is selected.
3. Find the "Core" folder in the left-hand treeview, at the top.
4. Select the "Parsing" node of the "Core" folder.
5. Set the "Parsing" option to "Incremental" or "Full." Automatic parsing doesn't update often enough. ("Full" may slow things down a bit but is a more thorough parse.)
6. Set the "Line change commit idle time" value to 250.
7. Set the "Idle time after a change" value to 1000.
8. Click OK to apply the changes and close the Options window. You should now see updates to the CR_Documentor window after approximately one second of editor idle time.

The "code" tag's "escaped" attribute doesn't properly handle whitespace.

Rather than use the "escaped" attribute, you can enclose the text in a CDATA tag. CDATA whitespace is properly handled. The "escaped" attribute is not supported by Sandcastle - it is an NDoc 1.3 specific feature.

The context menu templates may not insert/embed as expected if you have word wrap turned on in the Visual Studio editor.

This is a DXCore issue and nothing CR_Documentor can fix. If you are using word wrap in Visual Studio and find the templates aren't working right, turn off word wrap.

The CR_Documentor window may not display, and when looking in the DXCore error logs, you see an exception (System.Reflection.TargetInvocationException or System.MissingMethodException).

This generally means you don't have the minimum required version of DXCore installed - you need to upgrade.