Is possible to save the comments you do at the content files inside the source files? Also, there is a way to see at the content files the data present at the source files?
Thanks in advance.
Date
Votes
6 comments
-
Richard Sloggett There is an integrated Visual Editor provided by Document! X in Visual Studio that you can use to edit your source comments.
There isn't a way to import comments into source that you have already created in a Document! X Content File.
You can view the comments from your source whilst editing a Document! X Content File. To enable this option, click on the Properties toolbar button above the tree in the Content File editor and tick the 'Show content from source comments when editing' tick box. Once this option is enabled, your source comments will be visible in grey text when you are editing in the Content File.
Richard Sloggett
Innovasys
http://www.innovasys.com -
ISSoft This option would be great because we renamed one assembly and the namespace that it included and looks like we have lost all the data included in the content file. If the data would be stored on the source file we could retrieve the comments again.
Anyway thanks for the response.
-
ISSoft Hello, just another question. I've activated the option you told me and it work fine but, how can I refresh the conents shown when I change the source code comments. The content editor still shows the old comments (building the documentation builds the rigth text).
-
Richard Sloggett Document! X will never lose content that you have created in a Content File. If you remove a member, or a whole class, Document! X will prompt you (via a special 'Orphaned Content' dialog) to identify the new name of the members when you next open the content file for edit.
If your assembly or namespace names have changed, you can update the whole Content File by opening up the Content File in notepad (it is a UTF-8 encoded XML file) and do a find and replace to update the old assembly / namespace name to the new one.
Richard Sloggett
Innovasys
http://www.innovasys.com -
Richard Sloggett Document! X will always show the latest content from your assemblies XML documentation file when you activate the optionin the Content File editor.
You do need to rebuild your assembly in Visual Studio in order to have the latest source comments output to the assemblies XML documentation file and therefore visible in the Document! X Content File editor. Perhaps that is why you were seeing the old comments when you tried this?
Richard Sloggett
Innovasys
http://www.innovasys.com[quote user="ISSoft"]
Hello, just another question. I've activated the option you told me and it work fine but, how can I refresh the conents shown when I change the source code comments. The content editor still shows the old comments (building the documentation builds the rigth text).
[/quote] -
ISSoft Hello, we have found the issue. We started documenting in Debug mode, and now we have switched to Release. The content was pointing to the Debug dlls.
However we have not found a way of changing from Debug to Release DocumentX! so we deleted the Debug folder and then DocumentX asked for the DLL so finally we could change the DLL.
Just when we did that DocumentX asked for the Orphaned items so we recovered the lost data, so finally we get things working but the process was a bit ... 'dark'.
Thanks anyway.
Please sign in to leave a comment.