[wp-trac] [WordPress Trac] #41682: JSDoc correction for namespaces
WordPress Trac
noreply at wordpress.org
Tue Aug 22 13:00:52 UTC 2017
#41682: JSDoc correction for namespaces
--------------------------+-------------------------------
Reporter: herregroen | Owner:
Type: defect (bug) | Status: new
Priority: normal | Milestone: Awaiting Review
Component: General | Version:
Severity: normal | Resolution:
Keywords: has-patch | Focuses: javascript, docs
--------------------------+-------------------------------
Comment (by atimmer):
I think the eventual goal should be to have this on
developer.wordpress.org just like the parsed PHP code is on there. This
will make it possible to have user contributed notes and extra information
for functions and namespaces.
The way to get there is by building a convert step from JSDoc to WordPress
just like we have for PHP. The PHP work on this can be found on
https://github.com/wordpress/phpdoc-parser. I started on a JavaScript
version at https://github.com/yoast/jsdoc-parser. This could use all the
help it can get. The current idea is to use something like
https://www.npmjs.com/package/jsdoc-json to convert the internal JSDoc
representation to JSON and use that to create posts in a WordPress site.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/41682#comment:7>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list