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

DocumentationExtraction bug for java docstyle. #4029

Closed
damngamerz opened this Issue Mar 30, 2017 · 2 comments

Comments

3 participants
@damngamerz
Member

damngamerz commented Mar 30, 2017

DocumentationExtraction works good when java docstyle as given below is used.

/**
 * Returns an String that says Hello with the name argument.
 *
 * @param  name the name to which to say hello
 * @return      the concatenated string
 */

But if we remove that one space from that mid marker and end marker as follows

/**
* Returns an String that says Hello with the name argument.
*
* @param  name the name to which to say hello
* @return      the concatenated string
*/

DocumentationExtraction doesn't return anything. We need to throw a nice warning message for the above case.

@damngamerz

This comment has been minimized.

Show comment
Hide comment
@damngamerz
Member

damngamerz commented Mar 30, 2017

@NiklasMM

This comment has been minimized.

Show comment
Hide comment
@NiklasMM

NiklasMM Jun 16, 2017

Contributor

Right now the documentation extraction functions can only return an identified docstring or None. To deal with this issue, we should add an error state as a third possibility, when a start marker is found but the others aren't. I'm not sure if raising an Exception or returning some kind of error object is better.

Contributor

NiklasMM commented Jun 16, 2017

Right now the documentation extraction functions can only return an identified docstring or None. To deal with this issue, we should add an error state as a third possibility, when a start marker is found but the others aren't. I'm not sure if raising an Exception or returning some kind of error object is better.

@damngamerz damngamerz referenced this issue Jul 22, 2017

Merged

DocBaseClass: Fix java docstyle bug #4530

2 of 2 tasks complete

damngamerz added a commit to damngamerz/coala that referenced this issue Jul 24, 2017

DocBaseClass: Fix java docstyle bug
Bug fix for java docstyles having no trailing
spaces before marker[1] and marker[2]

Fixes coala#4029

@rultor rultor closed this in #4530 Jul 24, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment