Mod4j: Modeling for Java using Domain Specific Languages

Add pointers in Javadoc to the mutable implementing files

Details

  • Number of attachments :
    0

Description

When mod4j generates immutable files (you shouldn't change) the current class-level Javadoc isn't very clear.

For example see RolDaoBase.java:
/**

  • Generated by Mod4j at Wed Jan 14 10:55:13 CET 2009
    */
    //imports and package here
    /**
  • RolDaoBaseData Access Object (DAO). Responsible for accessing database.
    *
  • @author Mod4j generated
    *
    */

An improvement would be to add a clear "DO NOT MODIFY" and point the user (using correct Javadoc) to the extension point, like this:

/**

  • - DO NOT MODIFY - Generated by Mod4j at Wed Jan 14 10:55:13 CET 2009
    */
    //imports and package here
    /**
  • RolDaoBaseData Access Object (DAO). Responsible for accessing database.
    *
  • The extension point for this file can be found here:
  • @see nl.ordina.compcompas.data.spring.dao.RolDao
  • @author Mod4j generated
    *
    */

Jos Warmer [08/feb/09 05:27 PM]
Will change this gradually while fixing other issues.

Issue Links

Activity

There are no comments yet on this issue.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: