Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

php, java support #579

Closed
Ahmed-Badawy opened this issue Oct 28, 2016 · 1 comment
Closed

php, java support #579

Ahmed-Badawy opened this issue Oct 28, 2016 · 1 comment

Comments

@Ahmed-Badawy
Copy link

can it be modified to support php & java too.
both of them are very very similar to js.
i think it can easily be modified to support both of them too.

@tmcw
Copy link
Member

tmcw commented Nov 18, 2016

Good question! Any language that supports /** */-style comments (including Java and C++) is supported using the --polyglot option.

That said, the intent of this 'polyglot' mode is pretty particular: it's mostly for documenting node.js addons, that you write in C++ but that interact with JavaScript types. documentation has assumptions, like globals-docs that it's dealing with JavaScript types. Given that there's no popularly-accepted PHP-Node.js interlink, this usecase doesn't really fit that well.

So, yes, JSDoc comments in non JavaScript languages are supported. As far as broader language support and support for, say, C++ code that isn't intended for usage with JavaScript - that's currently out of scope for documentation.js. If someone really wanted to adopt that feature and spend the necessary time to implement and maintain it, I'd be open to that possibility. But as it is, increasing the scope of documentation.js to fit that usecase would overextend my own resources and knowledge.

@tmcw tmcw closed this as completed Nov 18, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants