search

AaronNGray / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Template links for functions with @event #292

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
What steps will reproduce the problem?
1. Create a function and tag it with @event.
2. Reference that function somewhere else with :event.function
3. Generate documentation.

What's the problem?
When the links in the documentation are clicked, the URL is incorrect.  It is 
linking to: "#event:.event:loading", when it should be linking to: 
"#event:.loading" -- I'm not entirely familiar with the templating system yet, 
but I'm guessing the problem probably lies there.

What version of the product are you using? On what operating system?
2.3.2 on Linux/Ubuntu 10.04 "Lucid"

Original issue reported on code.google.com by kyle.florence@gmail.com on 11 Jun 2010 at 8:49

GoogleCodeExporter commented 9 years ago 
A small but complete example would be useful, I can't tell from your note what 
the name of your event is: you say you linked to :event.function? Or is it 
named loading?

I'm going to assume it's named "loading". In that case you would link to 
"event:loading" 
If that's not specific enough advice please post a more complete example of the 
problem and I'll post an actual working response for you.

Original comment by micmath on 11 Jun 2010 at 10:52

GoogleCodeExporter commented 9 years ago 
Here is a link to the full source code: 
http://github.com/kflorence/jQuery.tabulate/raw/master/jquery.tabulate-1.0.js

An example would be the function $.tabulate.event_handlers.loading, which has 
been tagged with @event.  I then reference this in $.tabulate.tabulate like so: 
{@link jQuery.tabulate.event_handlers.event:loading} -- which gives me that URL 
issue.

Perhaps I am just linking to my event functions incorrectly?  Thanks for your 
help.

Original comment by kyle.florence@gmail.com on 13 Jun 2010 at 6:16

GoogleCodeExporter commented 9 years ago

Original comment by micmath on 13 Jun 2010 at 7:33

GoogleCodeExporter commented 9 years ago 
This has been fixed in revision 835. Thank you for reporting it.

Original comment by micmath on 13 Jun 2010 at 8:58