Comments (14)
nzakas
commented on August 20, 2024
Any chance this is also done? :)
from doctrine.
Constellation
commented on August 20, 2024
Could you file issues for each JSDoc 3 tag that is not supported by doctrine?
I'll fix them :)
from doctrine.
nzakas
commented on August 20, 2024
Yup, I'll let you know as I find them.
from doctrine.
jonathanKingston
commented on August 20, 2024
I'm working on a large commit of unit tests for these tags, so far spotted a few errors. I will reference them into this one and fix later in the day.
from doctrine.
jonathanKingston
commented on August 20, 2024
Found support for the following missing / untested:
- @author,
- @abstract,
- @desc,
- @global,
- @name
- @namespace
- @virtual
- @classdesc
- @constructor
- @constructs
- @copyright
- @default
- @deprecated
- @enum
- @event
- @example
- @exports
- @external
- @file
- @fires
- @ignore
- @inner
- @instance
- @Lends
- @license
- @link
- @member
- @memberof
- @method
- @mixes
- @mixin
- @module
- @Private
- @Protected
- @public
- @readonly
- @requires
- @see
- @SInCE
- @static
- @this
- @tutorial
- @typedef
- @Version
- @borrows
- @callback
I will add tickets for each one as and when resolving
from doctrine.
Constellation
commented on August 20, 2024
Cool
from doctrine.
jonathanKingston
commented on August 20, 2024
@Constellation its not that the support is there, mostly just the tests are not there. I started a branch will the tests for these as I write them but I think it would be better as separate tickets perhaps.
from doctrine.
Constellation
commented on August 20, 2024
@jonathanKingston
Ah sorry, I misunderstood.
from doctrine.
Constellation
commented on August 20, 2024
Simple tags are supported.
from doctrine.
jonathanKingston
commented on August 20, 2024
@Constellation I was still going to add tests for all of them. Like const and constant, writing tests for these cropped up errors.
I was going to work on all these or are you going to work on the ones you just added? Just wanted to minimise duplication of effort.
from doctrine.
Constellation
commented on August 20, 2024
@jonathanKingston:
Oh sorry. I'm now working on defining parseNamePath to represent some tags such as @this declaratively.
from doctrine.
Constellation
commented on August 20, 2024
I've implemented parseNamePath and redefine this tag with declarative form.
This may be useful for you :)
from doctrine.
jonathanKingston
commented on August 20, 2024
@Constellation yes very useful, I'll use the declarative style from now on also. That should clear up some of the code.
from doctrine.
kaicataldo
commented on August 20, 2024
Thanks for this issue. We have decided to officially end-of-life JSDoc support in ESLint. As a result, this repository and project will no longer be maintained.
Thanks for understanding and we apologize for any inconvenience.
from doctrine.
Related Issues (20)
- Support type intersections HOT 9
- What's the reason for the dot in stringifing TypeExpression (Array.<string>)? HOT 3
- Add support for @property without type HOT 2
- Mechanism for 'escaping' @ symbol when part of an example (i.e. Decorators) HOT 5
- Option for allowing multiple tags per line. HOT 1
- Permitting numeric keys in parameter names
- TypeError: Cannot read property 'replace' of undefined HOT 1
- fails to read @name tags with slashes HOT 1
- Using `unwrap` to parse Block comment without `*` separators breaks indentation. HOT 5
- Union type stringification does not respect compact flag
- Support for relative type references HOT 3
- @example warp the decorator does NOT work HOT 3
- The type is in 'name' when there is no name HOT 1
- Record type range gets offset after linebreaks HOT 1
- Support `@access package` HOT 1
- Support for TypeScript import types HOT 1
- doctrine not parsing @Param with default value HOT 1
- Avoid erring with "event:" within `@param` and `@returns` tags and any other allowed contexts HOT 1
- Allow for missing `@param`'s or `@return(s)` with `@implements` on the block; also possibly for @augments/@extends and @override HOT 1
- Archive this repository HOT 5
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 doctrine.