xml-doc-of-xml-fields

12 posts, 0 answers
  1. Allen
    Allen avatar
    42 posts
    Member since:
    Nov 2014

    Posted 06 Jan 2015 Link to this post

    Hi, Admins.
    See: http://www.telerik.com/forums/xml-documentation-of-xml-fields
    http://www.telerik.com/forums/visual-designer-description-field
    It seems a long time ago that things.
    For MSSQL, it's very simple.
    For other databases, it is not so hard.
    Why not implemented???
    Thank
  2. Viktor Zhivkov
    Admin
    Viktor Zhivkov avatar
    291 posts

    Posted 09 Jan 2015 Link to this post

    Hi Allen,

    You are welcome to post your feature suggestions in our Ideas and Feedback portal.
    There other clients will be able to see your suggestion, comment and vote for it if they want to support it.

    Regards,
    Viktor Zhivkov
    Telerik
     
    OpenAccess ORM is now Telerik Data Access. For more information on the new names, please, check out the Telerik Product Map.
     
  3. DevCraft banner
  4. Allen
    Allen avatar
    42 posts
    Member since:
    Nov 2014

    Posted 25 Jan 2015 in reply to Viktor Zhivkov Link to this post

    Hi, Viktor Zhivkov.
    Or open code generation interface, I implement it yourself.
    Thank.
  5. Doroteya
    Admin
    Doroteya avatar
    502 posts

    Posted 28 Jan 2015 Link to this post

    Hello Allen,

    Thank you for getting back to us.

    I am not sure that I understand what you mean. Could you elaborate a little bit more on the idea that you have in mind?

    Regarding the features quoted in the two forum threads, due to improvements with a higher priority for our community, we chose to postpone the implementation of XML documentation for the generated properties and utilization of the description column.

    I am looking forward to your feedback.


    Regards,
    Doroteya
    Telerik
     
    OpenAccess ORM is now Telerik Data Access. For more information on the new names, please, check out the Telerik Product Map.
     
  6. Allen
    Allen avatar
    42 posts
    Member since:
    Nov 2014

    Posted 03 Feb 2015 in reply to Doroteya Link to this post

    Hi, Doroteya.
    I'm sorry, I did not clearly express what I mean.
    ORM has open source code to generate API?

    Maybe I don't have to wait for your plans.
    I can do this on your own.
    Thanks.
  7. Doroteya
    Admin
    Doroteya avatar
    502 posts

    Posted 06 Feb 2015 Link to this post

    Hi Allan,

    Indeed, one of the most useful features of Telerik Data Access is the code generation provided by our T4 templates. They allow you to customize the actual code you get from Data Access and are available on your side for modification. In this section of our documentation, you can find step-by-step tutorials that will help you get to know the templates. Additionally, the metadata details that actually allow the generated code to work with the Telerik Data Access runtime are available in this section.

    I hope this helps. Do let us know, if you need further information.


    Regards,
    Doroteya
    Telerik
     
    OpenAccess ORM is now Telerik Data Access. For more information on the new names, please, check out the Telerik Product Map.
     
  8. Allen
    Allen avatar
    42 posts
    Member since:
    Nov 2014

    Posted 10 Feb 2015 in reply to Doroteya Link to this post

    Oh, no, no, no!
    Oh, I was so upset.
    I am afraid you didn't understand what I meant!

    T4 template is just one part.
    The key question is: we need to add a comment for each entity class properties.
    ORM does not provide property comment.
    Your development plans also do not know when to complete.
    So I want to implement this functionality yourself.
    In my scenario, there should be an interface to load third-party dll, in T4 templates, so I can add a comment for each entity class properties.

    Don't make me anti-ORM program is compiled, then find a generated interface called T4 templates.
    I do not want I want it to do.

    Thanks, Doroteya!!!


  9. Allen
    Allen avatar
    42 posts
    Member since:
    Nov 2014

    Posted 10 Feb 2015 in reply to Doroteya Link to this post

    I checked the Telerik.OpenAccess.CodeGeneration.dll file.
    Find Summary properties in the Telerik.OpenAccess.CodeGeneration.CodeElement class.
    I tried to call it a T4 template, but there is no value.
    Obviously, the ORM data retrieved from the database entity classes, did not obtain Summary values.
  10. Kristian Nikolov
    Admin
    Kristian Nikolov avatar
    206 posts

    Posted 12 Feb 2015 Link to this post

    Hello Allen,

    If I am understanding your situation correctly, your goal is to add XML comments to the classes and their properties in your Domain Model.

    If this is really what you need to achieve, you can do so with the following steps:
    1. Open the Visual Designer for your model.
    2. Select a domain class or a property of one.
    3. Open its Properties Window (usually via F4).
    4. In the Properties Window there is a Description property, fill it with the required information.
    5. Save your model.

    Doing this will generate XML comments in <summary></summary> tags containing the specified description for the class or property.

    Please note however that these comments will not be pushed to the database as table or column descriptions. If you are interested in such functionality you could vote for this feature request at our feedback portal. Doing so will help us prioritize its potential implementation.

    I hope this helps. If you have any more question, feel free to post at our forums again.


    Regards,
    Kristian Nikolov
    Telerik
     
    OpenAccess ORM is now Telerik Data Access. For more information on the new names, please, check out the Telerik Product Map.
     
  11. Allen
    Allen avatar
    42 posts
    Member since:
    Nov 2014

    Posted 02 Mar 2015 in reply to Kristian Nikolov Link to this post

    Hello, Kristian Nikolov.
    I know how to manually add.
    My goal is to Read all the description from the database tables,
    and [b]auto[/b] add XML comments to the classes and their properties in my Domain Model,
    instead of manually add.

    [b]Thanks[/b].
  12. Allen
    Allen avatar
    42 posts
    Member since:
    Nov 2014

    Posted 02 Mar 2015 in reply to Kristian Nikolov Link to this post

    Hello, Kristian Nikolov.

    I just wanted to be able to read all description from the database tables.
    Then auto add XML comments to the classes and their properties in my Domain Models.

    Of course, if you could bring that these comments pushed to the database as table or column descriptions., so much the better.

    Thanks.
  13. Boris Georgiev
    Admin
    Boris Georgiev avatar
    190 posts

    Posted 05 Mar 2015 Link to this post

    Hi Allen,

    Thank you for supporting the feature on our Ideas and Feedback portal.

    Currently, it is not on our road map for the next official release of Telerik Data Access - Q2 2015. I would recommend you to follow the feedback request through the Follow this item button, so that you receive notifications when the status of the item changes.

    Let us know, if you need further information.

    Regards,
    Boris Georgiev
    Telerik
     
    OpenAccess ORM is now Telerik Data Access. For more information on the new names, please, check out the Telerik Product Map.
     
Back to Top
DevCraft banner