This is a migrated thread and some comments may be shown as answers.

Kendo UI's JSDoc template?

2 Answers 30 Views
General Discussions
This is a migrated thread and some comments may be shown as answers.
Ryan
Top achievements
Rank 1
Ryan asked on 11 Jul 2012, 02:18 PM

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 Answers, 1 is accepted

Sort by
0
Alex Gyoshev
Telerik team
answered on 11 Jul 2012, 02:52 PM
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!
0
Ryan
Top achievements
Rank 1
answered on 11 Jul 2012, 04:04 PM
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
Tags
General Discussions
Asked by
Ryan
Top achievements
Rank 1
Answers by
Alex Gyoshev
Telerik team
Ryan
Top achievements
Rank 1
Share this question
or