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

Stop parameter parsing if no matching alias #117

Open
hinerm opened this issue Aug 29, 2014 · 3 comments
Open

Stop parameter parsing if no matching alias #117

hinerm opened this issue Aug 29, 2014 · 3 comments

Comments

@hinerm
Copy link
Member

hinerm commented Aug 29, 2014

Reported in http://fiji.sc/bugzilla/show_bug.cgi?id=921

If we encounter a potential alias parameter like @author but have no alias entry, it would be nice if we could just interpret that line as a standard non-parameter line if possible.

@ctrueden
Copy link
Member

Should be very easy to ignore such invalid parameters, issuing a warning about them to the log.

@dscho
Copy link
Contributor

dscho commented Sep 2, 2014

Hmpf. I am not sure that it is worth complicating and uglifying the otherwise beautiful design just for an invalid use case (@author makes a lot of sense for JavaDoc, but JavaDoc makes no sense with scripts).

I mean, yes, we can now go on and have a lengthy discussion about the merits and the downsides etc etc, but should we not perform some useful biological research instead?

@ctrueden
Copy link
Member

ctrueden commented Sep 2, 2014

If we go my route of a getCommentStyle and use EOL comment styles for that (e.g.: // for Java) then the "Javadoc" use case problem goes away.

We probably need to make that change anyway, to avoid other overly aggressive parsing situations. This problem will keep rearing its head in various forms until we fine tune things.

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

3 participants