Comments (11)
[deleted comment]
from jsdoc-toolkit.
[deleted comment]
from jsdoc-toolkit.
Unfortunately, because this feature assumes classnames, it will only be
possible to
implement this is the sunny template. That template already uses a linking
syntax
like this:
<a href="CLASSNAME.html#MEMBERNAME">
The JSDoc.pm @see tag syntax seems to be like this:
@see #MEMBERNAME
@see CLASSNAME
@see CLASSNAME#MEMBERNAME
Based on that the required rule would be to turn this into that:
{@see #MEMBERNAME} --> <a href="#MEMBERNAME">
{@see CLASSNAME} --> <a href="CLASSNAME.html">
{@see CLASSNAME#MEMBERNAME} --> <a href="CLASSNAME.html#MEMBERNAME">
This is fairly straightforward, though it will slow down the overall process of
producing output and I'm bothered by the fact that it will only work in the
sunny
template. I'd like to think about this and hopefully come up with a way toget
this to
work in any template.
Original comment by micmath
on 8 Sep 2007 at 9:37
- Added labels: Type-Enhancement
- Removed labels: Type-Defect
from jsdoc-toolkit.
Note that the @extends tag is already supported, and there is currently another
issue
open requesting enhancements to it. Any further discussion of @extends
enhancementsshould happen in that issue or a separate issue.
Original comment by micmath
on 8 Sep 2007 at 9:38
from jsdoc-toolkit.
Removed @extends from the Summary.
Original comment by micmath
on 8 Sep 2007 at 9:39
from jsdoc-toolkit.
This is slated to be implemented by the next feature release: 1.4
Original comment by micmath
on 8 Sep 2007 at 9:43
- Added labels: Milestone-Release1.4
from jsdoc-toolkit.
Original comment by micmath
on 8 Sep 2007 at 9:44
- Changed state: Accepted
from jsdoc-toolkit.
[deleted comment]
from jsdoc-toolkit.
[deleted comment]
from jsdoc-toolkit.
Why would that (i.e., the "@see" directive) only work in the sunny template?
I haven't digged into the code, but isn't there some sort of registry of "type
name"
-> "file name", which other templates might use
(That way, a "see" directive could be treated by all templates)?
(btw, why don't other templates use the same type-name-based file names?)
Original comment by [email protected]
on 12 Dec 2007 at 4:02
from jsdoc-toolkit.
This is implemented and working in version 2.
Original comment by micmath
on 20 Feb 2008 at 12:20
- Changed state: Fixed
from jsdoc-toolkit.
Related Issues (20)
- @exports does not export to another symbol's prototype properly HOT 3
- Assignment of a function to a prior declared variable incorrectly considered global HOT 2
- Aliased items are replaced with the first matching exported variable, even if it is not a full match. HOT 1
- Missing semi-colons in TokenReader prevent use of rhino 1.7R3 HOT 1
- Missing semicolon in TokenReader.js, line 17 HOT 1
- Private variables in anonymous function declared as constructor not exported
- Special characters in type expressions are not escaped properly in HTML output
- publishSrcHilite
- Better app/frame/Link.js
- Multiline comment may break the generated doc if it starts with a slash HOT 1
- Notice on front page makes it look like this project is dead. HOT 1
- support: best way to document input objects HOT 1
- removed extra pasted text
- Spelling correction
- Patch for /wiki/TagThrows.wiki
- Getting Started/Introduction missing
- File Index and _global_
- page https://code.google.com/p/jsdoc-toolkit/wiki/TagType does not contain type's descriptions
- can't find way to document code with closure
- uninitialized field documnetation not shown in output
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from jsdoc-toolkit.