Search function?

[John Lantz]

We're using YuiDoc to generate our API docs here:

http://www.breezejs.com/sites/all/apidocs/index.html

It's very easy for folks to find the classes and modules using the generated list as well as the api filter.

That being said, we've had quite a few people request that the api filter form work like a search form instead. (i.e. it queries the comments, properties, methods, events, etc., etc.)

Does such a thing exist for YuiDocs? Or do we need to add a separate search-engine powered widget?

[Dav Glass]

You would need to add your own API to search but YUIDoc does provide a `data.json` file for you to consume:

http://yui.github.com/yuidoc/args/index.html#working-with-yuidoc-parsed-data

You could easily write up a quick web service to serve that data filtered.

--
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/-/hGJ0Nzfq_GwJ.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

[John Lantz]

Thanks Dav.

[Jose Pita]

Hey Dav, I just started using yuidoc and I really need this functionality but I am a noob in all of this, can you give me some pointers on how to do this?

I just need to be able to, when I go to the index.html file from yuidoc, search the entire "content" instead of just the classes or modules.

Thanks in advance.