We Moved - This Forum is now Read-Only

Our new community is now available at https://support.submain.com/community/. We will leave historical discussions here in this forum view-only mode for search purposes, but moving forward, please post your questions in the appropriate category in the new community.

 
  SubMain - CodeIt.Right The First Time!

/Community

Support Community for SubMain Products
 Home Products Services Download Purchase Support
in Search
 
Home Forums Blogs Tutorials/CIR Tutorials/GD Downloads
Welcome to SubMain Community Sign in | Join | Help

GhostDoc engine gets broken if CodeElement.ReturnType is type of List<T>

Last post 09-05-2012, 10:12 AM by DaveN. 4 replies.
Sort Posts: Previous Next
  •  07-19-2012, 2:26 PM 2512

    GhostDoc engine gets broken if CodeElement.ReturnType is type of List<T>

    Hi all,

    I
    've introduced my own rules to extend the xml output of properties, methods, fields, etc. As mentioned in the subject, the processor stops processing, if it hits on a List<T> type.

    Take this short code snippet as an example:
    public List<string> TestMethod(List<string> test)
    {
            return test;
    }

    Furthermore I've got some strange behavior with fields and CodeElement.ReturnType. If I will go to ignore CodeElement.HasReturnType, the CodeElement.ReturnType is representing the actual field type, which is quite good. Unfortunately, accessing this property of CodeElement will result in an error too.


    W
    hat I've also figured out: If I write additional documentation tags such as <typeparam>, these tags become duplicated in case Context.GetNonGeneratedTags() is used.

    I'm using the latest version of GhostDoc. Please provide some feedback, if and when this issue will be addressed.

    Regards, Cadenza 

     

  •  07-30-2012, 4:11 AM 2566 in reply to 2512

    Re: GhostDoc engine gets broken if CodeElement.ReturnType is type of List<T>

    Hi, any news about this topic? Is there more detail I could provide?
  •  07-30-2012, 7:10 AM 2572 in reply to 2566

    Re: GhostDoc engine gets broken if CodeElement.ReturnType is type of List&lt;T&gt;

    Okay, 

    after some internal research I have figured out, that the less-than and the greater-than signs caused this behavior in my code.

    Escaping this characters has solved the problem.
     
  •  07-30-2012, 10:17 PM 2577 in reply to 2572

    Re: GhostDoc engine gets broken if CodeElement.ReturnType is type of List&lt;T&gt;

    Thank you for sharing the solution. We will make sure to address the issue.

     


    Thank you,
    Serge Baranovsky
    http://submain.com - .NET Developer Tools  |  Microsoft MVP  |  ASP Insider
    » » CodeIt.Right Will Fix Your Code!™ - http://submain.com/codeit.right
    » » C#/VB .NET Coding Guidelines - FREE 100+ page ebook (PDF) http://submain.com/guidelines
  •  09-05-2012, 10:12 AM 2712 in reply to 2572

    Re: GhostDoc engine gets broken if CodeElement.ReturnType is type of List&lt;T&gt;

    @Cadenza, Can you provide more detail on how you solved this? I'm experiencing the same issue in v4 Beta.

    Never mind, version 4.0.12250 addresses this.  GhostDoc now generates <returns>List{System.String}</returns> as expected.

View as RSS news feed in XML
 
     
 
Home |  Products |  Services |  Download |  Purchase |  Support |  Community |  About Us |