Updating method docs the <returns> element is getting cleared.
Problem reported by Rocco - 8/17/2018 at 6:33 AM
Hey Guys,
GhostDoc Version: 5.9.18070
VS2017 Version: 15.7.3
Example method:
 /// <summary>
 /// Gets all manufacturers.
 /// </summary>
 /// <returns></returns>
 public IEnumerable<Manufacturer> GetAllManufacturers() {
     return _lsapi.GetFiltered<Manufacturer>();
_lsapi.GetFiltered<T>() returns IEnumerable<T>
Using "Document This" command the <returns></returns> element is cleared.  If I paste text into the <returns></returns> element and try again it clears the pasted-in text.
 - Rock

3 Replies

Reply to Thread
Misha Zhutov Replied
Employee Post

We found the cause of the issue. The problem is that the string
_lsapi.GetFiltered<T>() returns IEnumerable<T> is not valid inside XML.
Please try this one:
_lsapi.GetFiltered&lt;T&gt;() returns IEnumerable&lt;T&gt;

Rocco Replied
OK thanks.

Ah Ha! That works but it doesn't read very well.

After your answer gave me some direction I used:
/// <summary>
/// Gets all purchase orders.
/// </summary>
/// <returns>
/// <![CDATA[ IEnumerable<Order> ]]>
/// </returns>

and that works Ok and an update does not delete it.

Thank you for your help.
- rock
Misha Zhutov Replied
Employee Post
Hi Rock, thank you for the update.

Reply to Thread