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

Multiline comment in JDL becomes a single-line comment in the generated file #22441

Closed
1 task done
jayveeAtWork opened this issue Jun 6, 2023 · 0 comments · Fixed by #23530
Closed
1 task done

Multiline comment in JDL becomes a single-line comment in the generated file #22441

jayveeAtWork opened this issue Jun 6, 2023 · 0 comments · Fixed by #23530
Labels
$$ bug-bounty $$ https://www.jhipster.tech/bug-bounties/ theme: JDL $100 https://www.jhipster.tech/bug-bounties/
Milestone

Comments

@jayveeAtWork
Copy link

Overview of the issue

A multi-line javadoc comment on an entity in the JDL gets concatenated into a single-line javadoc comment in the generated java code. The break between lines has been translated to a literal \n in the generated code.

/**
 * The Calendar represents an expectation of a process execution for a specific version of the
 * business reality, i.e. the business reality valid at the underlying BusinessDate.
 */
entity Calendar{
    id UUID,
    name String required
}

becomes...

/**
 * The Calendar represents an expectation of a process execution for a specific version of the\nbusiness reality, i.e. the business reality valid at the underlying BusinessDate.
 */
Motivation

Concatenating to a single line breaks long-line rules in lint, is less readable, and the added literal \n seems just plain wrong.

Reproduce the error

Create a multiline javadoc comment on an entity, then generate it.

Related issues

Seems like this (old, closed) issue might be related.

JHipster Version(s)

generator-jhipster@7.9.3

  • Checking this box is mandatory (this is just to show you read everything)
@deepu105 deepu105 added $100 https://www.jhipster.tech/bug-bounties/ $$ bug-bounty $$ https://www.jhipster.tech/bug-bounties/ labels Aug 15, 2023
@deepu105 deepu105 added this to the 8.0.0-rc.1 milestone Oct 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
$$ bug-bounty $$ https://www.jhipster.tech/bug-bounties/ theme: JDL $100 https://www.jhipster.tech/bug-bounties/
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants