WYSIWYG Generates Invalid XML

Problem reported by MD - 11/11/2019 at 10:27 AM

Resolved

Using this XML:

https://github.com/ExtendedXmlSerializer/ExtendedXmlSerializer/blob/1e3e5410c1adeacb2dd17c9e0f0b3fe584ab3ee6/src/ExtendedXmlSerializer/ExtensionMethods.ExtensionModel.cs#L25-L38

I hit CTRL-SHIFT-D on it, to open your amazing WYSIWYG editor. :)

Notice the "Notice"... I want to convert this to a note.

This generates the result:

		/// <summary>
		///   <para>
		/// Specifies an existing reference to use as target for deserialization of values.  Read values during
		/// deserialization will be read and assigned into the provided target instance.
		/// </para>
		///   <note type="important">Be sure to call <see cref="M:ExtendedXmlSerializer.ExtensionMethods.AllowExistingInstances(IConfigurationContainer)"> when configuring the container before using this method. </see></note>
		///   <para></para>
		/// </summary>
		/// <typeparam name="T">The instance type.</typeparam>
		/// <param name="this">The serializer</param>
		/// <param name="instance">The instance to deserialize</param>
		/// <returns>A ReferencedDeserialization&lt;T&gt; context.</returns>
		/// <seealso href="https://github.com/ExtendedXmlSerializer/ExtendedXmlSerializer/issues/230"; />

When attempting to CTRL-SHIFT-D on this generated XML, I get the following:

This might be due to being a newb with all this magic. Please let me know if there is something obvious I am overlooking. Thank you!

7 Replies

Reply to Thread

MD Replied

11/11/2019 at 10:28 AM

FWIW I have this captured in a video here:

https://youtu.be/1hDAFGhFVlc

Misha Zhutov Replied

11/12/2019 at 12:43 AM

Employee Post

Hello,

Thank you for reporting that. We will take a look at that and get back to you shortly.

Misha Zhutov Replied

11/12/2019 at 5:23 AM

Employee Post

We found a problem. According to the <see> tag specification it cannot contain text inside it (like <see cref="AllowExistingInstances"> when configuring the container before using this method. </see>) and GhostDoc does not support it. If you delete the text and use just <see cref="AllowExistingInstances" /> it will work.

MD Replied

11/12/2019 at 5:43 AM

Correct, that is the problem @Misha, thank you for investigating.

However, please note that it is the GhostDoc editor that is creating the invalid XML. Please see the video above.

Here are the steps to reproduce:

Use the XML found here (note that it is well-formed and valid).
CTRL-SHIFT-D on it.
Select the NOTICE text and cut.
Create new Note.
Paste text (removing Notice since it's in a note) -- in this case, I selected important.
Click OK
Click Save

At this point, you should see the invalid XML as pasted above. This is the result of the GhostDoc WYSIWYG dialog. At least, this is what I am experiencing on my machine. Please let me know if there is any further information I can provide to help diagnose.