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

Automagically parse stuff without leading character #2

Open
IvanSanchez opened this issue Aug 31, 2015 · 2 comments
Open

Automagically parse stuff without leading character #2

IvanSanchez opened this issue Aug 31, 2015 · 2 comments

Comments

@IvanSanchez
Copy link
Member

From a conversation with @mourner:

Is the 🍂really mandatory or can we just get rid of it in Leafdoc and do some simple heuristics to determine if a comment is a docs comment? Always hated rules that /** jsdoc one, this was is even harsher
e.g. if a comment looks like method foo(), it's probably a doc; if it's parsed like a doc and there's an error, we could just ignore it

@ddproxy
Copy link
Member

ddproxy commented Nov 8, 2016

I'd gander that a switch to turn this on would be appropriate, with warnings.

@IvanSanchez
Copy link
Member Author

Since the code is now using multilang-extract-comments, it would be possible to check if a psrsed comment block has the apidoc property.

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