Custom tags

339 views
Skip to first unread message

Alexey Ozerov

unread,
Jul 22, 2012, 2:15:49 PM7/22/12
to yui...@googlegroups.com
Is it possible to configure yuidoc to use custom tags?
For example, I want to use two tags @implemented and @notimplemented to mark a class's methods. Also I need to have checkboxes on the main maodule's page to hide/show implemented and not implemented methods.

I've checked documentation but found nothing.

Thanks in advance for any help.

Dav Glass

unread,
Jul 22, 2012, 4:11:58 PM7/22/12
to yui...@googlegroups.com
There is no "built-in" way to deal with custom tags, but overriding
the GUI is pretty simple:

http://yui.github.com/yuidoc/themes/index.html#overriding-a-partiallayout

Let me look into the best way to allow tag overrides.

--
Dav Glass
davg...@gmail.com
blog.davglass.com


+ Windows: n. - The most successful computer virus, ever. +
+ A computer without a Microsoft operating system is like a dog
without bricks tied to its head +
+ A Microsoft Certified Systems Engineer is to computing what a
McDonalds Certified Food Specialist is to fine cuisine +
> --
> You received this message because you are subscribed to the Google Groups
> "yuidoc" group.
> To post to this group, send email to yui...@googlegroups.com.
> To unsubscribe from this group, send email to
> yuidoc+un...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msg/yuidoc/-/PbVBgpqeNkwJ.
> For more options, visit https://groups.google.com/groups/opt_out.
>
>

Alexey Ozerov

unread,
Jul 22, 2012, 6:56:55 PM7/22/12
to yui...@googlegroups.com
Hi Dav,

Thank you for quick response!

What do you think is it correct way to copy ~/.npm/yuidocjs/0.3.13/package/themes/default somewhere and modify it's /partials/method.handlebars file to add necessary tags?
It seems I may add @not/implemented tags/checkboxes (@deprecated is a good example). 

After that apidocs.js and main.css should be changed.

Quite sad that there is no "built-in" way for all that.

Alexey Ozerov.

On Monday, July 23, 2012 12:11:58 AM UTC+4, Dav Glass wrote:
There is no "built-in" way to deal with custom tags, but overriding
the GUI is pretty simple:

http://yui.github.com/yuidoc/themes/index.html#overriding-a-partiallayout

Let me look into the best way to allow tag overrides.

--
Dav Glass

On Sun, Jul 22, 2012 at 1:15 PM, Alexey Ozerov wrote:
Reply all
Reply to author
Forward
0 new messages