PK50381: RSA: Round-trip engineering of documentation is inconsistent

APAR status

• Closed as program error.

Error description

• In IBM Rational Software Architect the round-trip engineering of
  documentation is inconsistent. Transforming from UML to Java do
  cumentation is placed below the first set of user-doc tags. Tran
  sforming from Java to UML documentation is not read from that lo
  cation. To update the documentation in the model, a user must cr
  eate their own javadoc  declaration and placed their documentati
  on.
  Steps to reproduce:
  1. Create a model
  2. Create a package named support
  3. Create a class named Tech under support
  4. Enter documentation in the documentation field for the class
  5. Create a UML to Java transformation configuration
  6. Enable reverse transformation
  7. Run the UML to Java transformation
  8. Modify the generated comments
  9. Run the Java to UML transformation
  Notice:
  The fuse does not detect a change
  10. Create a javadoc section and place documentation inside the
  javadoc tags
  11. Run the Java to UML transformation
  Notice:
  The documentation field is updated with the documentation that w
  as placed inside the created javadoc tags.
  

Local fix

Problem summary

• RSA: Round-trip engineering of documentation is inconsistent
  

Problem conclusion

• This issue now fixed with a series of enhancements meant to
  improve roundtrip engineering. UML documentation will now
  appear inside user doc tags:
  /**
   * ?!-- begin-user-doc --?
   * UML Element documentation goes here.
   * ?!-- end-user-doc --?
   * @author kgardner
   * @generated "UML to Java
  (com.ibm.xtools.transform.uml2.java5.internal.UML2JavaTransf
  orm)"
   */
  On reverse the transformation will transform any
  documentation between  ?!-- begin-user-doc --? and ?!--
  end-user-doc --? back into the UML documentation field.
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  SW ARCHITECT WI

• Fixed component ID

  5724I7001

Applicable component levels

• R700 PSN

     UP