Kendo UI's JSDoc template?

3 posts, 0 answers
  1. Ryan
    Ryan avatar
    16 posts
    Member since:
    Jun 2012

    Posted 11 Jul 2012 Link to this post


    Hello -- we are building a large number of widgets that either extend Kendo UI widgets or have similar APIs, and it would be really nice to generate Kendo UI-like HTML documentation using JSDoc.  However, a number of the tags used in the Kendo UI code are not standard JSDoc syntax.  As Kendo tweeted here:

    http://twitter.com/KendoUI/statuses/173019911008960512

    "we use a modified jsDoc template that parses our configuration objects (that are passed to the jQuery plug-ins)"

    Is there any chance this JSDoc template could be made available so that Kendo UI users could employ the same documentation patterns to promote consistency and compatibility?  Thanks!

    ryan
  2. Alex Gyoshev
    Admin
    Alex Gyoshev avatar
    2527 posts

    Posted 11 Jul 2012 Link to this post

    Hello Ryan,

    We have migrated away from the JsDoc syntax, towards markdown, in a the kendo-docs public repository on github.

    Regards,
    Alex Gyoshev
    the Telerik team
    Join us on our journey to create the world's most complete HTML 5 UI Framework - download Kendo UI now!
  3. Ryan
    Ryan avatar
    16 posts
    Member since:
    Jun 2012

    Posted 11 Jul 2012 Link to this post

    Haha, yeah, I just saw that news on the webcast.  Good timing, I guess!  We will probably proceed to use markdown, as well.  Thanks!

    ryan
Back to Top