add class and field comments to entity generator #1952

andidev · 2015-08-29T20:03:01Z

relates to jhipster/jhipster-uml#46
fix #1949

andidev · 2015-08-29T20:03:53Z

{
    "relationships": [
        {
            "relationshipId": 1,
            "relationshipName": "complexJavadocRelationship",
            "otherEntityName": "complexJavadocRelationship",
            "relationshipType": "one-to-many",
            "otherEntityRelationshipName": "complexJavadocEntity",
            "javadoc": "<p>This class represents the Magna ligula pellentesque. Lacus ut sed. Himenaeos litora et posuere. Accumsan purus inceptos. Ultricies praesent metus. &#47;* Fames odio quam. *&#47;</p><p>TODO:</p>\n\n<ul>\n<li>first &uuml;ber</li>\n<li>second</li>\n</ul>\n\nMake sure that json special characters like double quotes \" and backslashes \\ are escaped in json file and correctly displayed in javadoc"
        }
    ],
    "fields": [
        {
            "fieldId": 1,
            "fieldName": "complexJavadocField",
            "fieldType": "String",
            "javadoc": "<p>This class represents the Magna ligula pellentesque. Lacus ut sed. Himenaeos litora et posuere. Accumsan purus inceptos. Ultricies praesent metus. &#47;* Fames odio quam. *&#47;</p><p>TODO:</p>\n\n<ul>\n<li>first &uuml;ber</li>\n<li>second</li>\n</ul>\n\nMake sure that json special characters like double quotes \" and backslashes \\ are escaped in json file and correctly displayed in javadoc"
        }
    ],
    "changelogDate": "20150829194644",
    "dto": "no",
    "pagination": "no",
    "javadoc": "<p>This class represents the Magna ligula pellentesque. Lacus ut sed. Himenaeos litora et posuere. Accumsan purus inceptos. Ultricies praesent metus. &#47;* Fames odio quam. *&#47;</p><p>TODO:</p>\n\n<ul>\n<li>first &uuml;ber</li>\n<li>second</li>\n</ul>\n\nMake sure that json special characters like double quotes \" and backslashes \\ are escaped in json file and correctly displayed in javadoc"
}

will generate

/**
 * <p>This class represents the Magna ligula pellentesque. Lacus ut sed.
 * Himenaeos litora et posuere. Accumsan purus inceptos. Ultricies praesent
 * metus. &#47;* Fames odio quam. *&#47;</p><p>TODO:</p>
 * 
 * <ul>
 * <li>first &uuml;ber</li>
 * <li>second</li>
 * </ul>
 * 
 * Make sure that json special characters like double quotes " and backslashes
 * \ are escaped in json file and correctly displayd in javadoc
 */
@Entity
@Table(name = "COMPLEXJAVADOCENTITY")
@Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
public class ComplexJavadocEntity implements Serializable {

    ...

    /**
     * <p>This class represents the Magna ligula pellentesque. Lacus ut sed.
     * Himenaeos litora et posuere. Accumsan purus inceptos. Ultricies praesent
     * metus. &#47;* Fames odio quam. *&#47;</p><p>TODO:</p>
     * 
     * <ul>
     * <li>first &uuml;ber</li>
     * <li>second</li>
     * </ul>
     * 
     * Make sure that json special characters like double quotes " and
     * backslashes \ are escaped in json file and correctly displayd in javadoc
     */  
    @Column(name = "complex_javadoc_field")
    private String complexJavadocField;

    /**
     * <p>This class represents the Magna ligula pellentesque. Lacus ut sed.
     * Himenaeos litora et posuere. Accumsan purus inceptos. Ultricies praesent
     * metus. &#47;* Fames odio quam. *&#47;</p><p>TODO:</p>
     * 
     * <ul>
     * <li>first &uuml;ber</li>
     * <li>second</li>
     * </ul>
     * 
     * Make sure that json special characters like double quotes " and
     * backslashes \ are escaped in json file and correctly displayd in javadoc
     */
    @OneToMany(mappedBy = "complexJavadocEntity")
    @JsonIgnore
    @Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
    private Set<ComplexJavadocRelationship> complexJavadocRelationships = new HashSet<>();

    ...

}

deepu105 · 2015-08-30T03:54:21Z

Awesome and they are optional right? May be we can add another quest in
entity generator to capture this from user as optional input as well what
say?
On 30 Aug 2015 04:04, "Anders Steiner" notifications@github.com wrote:

{
"relationships": [
{
"relationshipId": 1,
"relationshipName": "complexJavadocRelationship",
"otherEntityName": "complexJavadocRelationship",
"relationshipType": "one-to-many",
"otherEntityRelationshipName": "complexJavadocEntity",
"javadoc": "
This class represents the Magna ligula pellentesque. Lacus ut sed. Himenaeos\nlitora et posuere. Accumsan purus inceptos. Ultricies praesent metus. /\nFames odio quam. */
TODO:
\n\n
\n
first über
\n
second
\n
\n\nMake sure that json special characters like double quotes " and backslashes \ are escaped in json file and correctly displayd in javadoc"
}
],
"fields": [
{
"fieldId": 1,
"fieldName": "complexJavadocField",
"fieldType": "String",
"javadoc": "
This class represents the Magna ligula pellentesque. Lacus ut sed. Himenaeos\nlitora et posuere. Accumsan purus inceptos. Ultricies praesent metus. /\nFames odio quam. /
TODO:
\n\n
\n
first über
\n
second
\n
\n\nMake sure that json special characters like double quotes " and backslashes \ are escaped in json file and correctly displayd in javadoc"
}
],
"changelogDate": "20150829194644",
"dto": "no",
"pagination": "no",
"javadoc": "
This class represents the Magna ligula pellentesque. Lacus ut sed. Himenaeos\nlitora et posuere. Accumsan purus inceptos. Ultricies praesent metus. /\nFames odio quam. */
TODO:
\n\n
\n
first über
\n
second
\n
\n\nMake sure that json special characters like double quotes " and backslashes \ are escaped in json file and correctly displayd in javadoc"
}

will generate

/** *
This class represents the Magna ligula pellentesque. Lacus ut sed. Himenaeos * litora et posuere. Accumsan purus inceptos. Ultricies praesent metus. /* * Fames odio quam. */
TODO:
* *
*
first über
*
second
*
* * Make sure that json special characters like double quotes " and backslashes \ are escaped in json file and correctly displayd in javadoc */
@entity
@table(name = "COMPLEXJAVADOCENTITY")
@Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)public class ComplexJavadocEntity implements Serializable {
...

/** * This class represents the Magna ligula pellentesque. Lacus ut sed. Himenaeos * litora et posuere. Accumsan purus inceptos. Ultricies praesent metus. &#47;* * Fames odio quam. *&#47;TODO: * * <ul> * <li>first &uuml;ber</li> * <li>second</li> * </ul> * * Make sure that json special characters like double quotes " and backslashes \ are escaped in json file and correctly displayd in javadoc */
@Column(name = "complex_javadoc_field")
private String complexJavadocField;

/** * This class represents the Magna ligula pellentesque. Lacus ut sed. Himenaeos * litora et posuere. Accumsan purus inceptos. Ultricies praesent metus. &#47;* * Fames odio quam. *&#47;TODO: * * <ul> * <li>first &uuml;ber</li> * <li>second</li> * </ul> * * Make sure that json special characters like double quotes " and backslashes \ are escaped in json file and correctly displayd in javadoc */
@OneToMany(mappedBy = "complexJavadocEntity")
@JsonIgnore
@Cache(usage = CacheConcurrencyStrategy.NONSTRICT_READ_WRITE)
private Set<ComplexJavadocRelationship> complexJavadocRelationships = new HashSet<>();

...
}

—
Reply to this email directly or view it on GitHub
#1952 (comment)
.

andidev · 2015-08-30T04:56:55Z

It's fine by me. What do you sat @jdubois? This will lead to a lot more questioning but that is maybe no issue.

andidev · 2015-08-30T10:31:08Z

Added wordwrap on javadoc comment. It wraps att 80 characters. Not sure what the standard wordwrap is used for jhipster. @jdubois you have any input on this?

jdubois · 2015-08-30T17:45:06Z

@andidev I don't want to have all those added questions, it's just going to be annoying most of the time. My opinion is that the class and field names should be clear enough, so that documenting them is useless (most of the time). I also believe clean coding names are the best documentation.
For the line length, the policy is to follow Intellij IDEA rules, but to be honnest I'm not sure what they are here!

andidev · 2015-08-30T21:28:57Z

Okey I have a look at intellijs default setting.

@jdubois
Are you okey with adding this feature at least for the jhipster uml (without questions asked by the generator)? I actually agree with you but that comments should not be needed but in complex systems they sometime could help.

jdubois · 2015-08-31T19:59:53Z

@andidev yes this would only be for JHipster UML, as it makes sense in this case to have the comments coming from the UML tool (this is in fact something I've done in the past, when I was using ArgoUML, probably around 2000 or 2001...)

cbornet · 2015-09-01T07:22:58Z

It would also be great to have these comments fill the swagger doc.

andidev · 2015-09-01T15:36:11Z

@cbornet unfortunately I have no swagger skills 😢
Could you hint me where the comments should be added so that swagger shows them?

cbornet · 2015-09-01T21:02:22Z

@andidev You can use @ApiModel on the class and @ApiModelProperty on the attributes https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X#apimodel
Not sure how swagger-ui will react to html text though...

andidev · 2015-09-26T17:37:29Z

Did not find a way to deal with swagger.

Jhipster UML seems to be done with their work on their side. We should either merge this or close this PR. Are there any doubts on merging this @jdubois?

relates to jhipster/jhipster-um#46 fix jhipster#1949

andidev · 2015-09-26T18:52:13Z

Fixed merge conflict so it should be mergable now

…-entity-generator add class and field comments to entity generator

andidev mentioned this pull request Aug 29, 2015

Transfer UML attribute or class comments to source code of generated entities jhipster/jhipster-uml#46

Closed

deepu105 added the area: feature request 💡 label Sep 2, 2015

andidev force-pushed the add-class-and-field-comments-to-entity-generator branch from 3a4f2fe to e16a911 Compare September 26, 2015 18:46

andidev added 3 commits September 26, 2015 20:50

add class and field comments to entity generator

77cfef1

relates to jhipster/jhipster-um#46 fix jhipster#1949

wordwrap javadoc comments on 80 characters

36dc27e

add variable for wordwrap width

26d5dd1

andidev force-pushed the add-class-and-field-comments-to-entity-generator branch from e16a911 to 26d5dd1 Compare September 26, 2015 18:51

jdubois added a commit that referenced this pull request Oct 3, 2015

Merge pull request #1952 from andidev/add-class-and-field-comments-to…

5702369

…-entity-generator add class and field comments to entity generator

jdubois merged commit 5702369 into jhipster:master Oct 3, 2015

jdubois modified the milestone: Untracked PRs Oct 21, 2015

cbornet mentioned this pull request Nov 29, 2015

Add swagger doc annotations from javadoc #2415

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add class and field comments to entity generator #1952

add class and field comments to entity generator #1952

andidev commented Aug 29, 2015

andidev commented Aug 29, 2015

deepu105 commented Aug 30, 2015

andidev commented Aug 30, 2015

andidev commented Aug 30, 2015

jdubois commented Aug 30, 2015

andidev commented Aug 30, 2015

jdubois commented Aug 31, 2015

cbornet commented Sep 1, 2015

andidev commented Sep 1, 2015

cbornet commented Sep 1, 2015

andidev commented Sep 26, 2015

andidev commented Sep 26, 2015

add class and field comments to entity generator #1952

add class and field comments to entity generator #1952

Conversation

andidev commented Aug 29, 2015

andidev commented Aug 29, 2015

deepu105 commented Aug 30, 2015

andidev commented Aug 30, 2015

andidev commented Aug 30, 2015

jdubois commented Aug 30, 2015

andidev commented Aug 30, 2015

jdubois commented Aug 31, 2015

cbornet commented Sep 1, 2015

andidev commented Sep 1, 2015

cbornet commented Sep 1, 2015

andidev commented Sep 26, 2015

andidev commented Sep 26, 2015