Fornax-Platform
Forum

[Sculptor] Generate javadoc for attributes?

by polly.c.chang :: Rate this Message:

Reply to Author | View in Thread

Hi,

First of all, I'm really impressed with Sculptor!  I thought that I was going to have to write something similar and not nearly as powerful, and then I discovered this project.  So thanks for making my life easier.  :)

I do have a question though.  Is there any way to generate javadoc for the attributes in the domain object?  For example, I would like my class to declare attributes like this:

        /** Address Line 1. */
        private String addressLine1;
       
        /** Address Line 2. */
        private String addressLine2;
       
So I edited the "model.design" file like this:

        /** Address Line 1. */
        String addressLine1 nullable
       
        /** Address Line 2. */
        String addressLine2 nullable

However, the comments are ignored.  I also looked at the DomainObject.xpt template, but I cannot figure out how to get to the comments.  I'd like to be able to generate them because we have a Checkstyle rule that all attributes must be commented.  Plus, it's just nice for documentation purposes.  So how should I specify the comments?

Thanks!
--Polly

 « Return to Thread: [Sculptor] Generate javadoc for attributes?

LightInTheBox - Buy quality products at wholesale price!