Configuring Descriptor Comments

You can define a free-form textual comment for each descriptor. You can use these comments however you whish: for example, to record important project implementation details such as the purpose or importance of a descriptor.

Comments are stored in the TopLink Workbench project, in the TopLink deployment XML file. There is no Java API for this feature.

Table 28-7 summarizes which descriptors support descriptor comment configuration.

Table 28-7 Descriptor Support for Descriptor Comment Configuration

Descriptor	Using TopLink Workbench	Using Java
Relational Descriptors
Object-Relational Descriptors
EIS Descriptors
XML Descriptors

Using TopLink Workbench

To create a comment for a descriptor, use this procedure:

1. In the Navigator, select a descriptor.

2. Click the Descriptor Info tab in the Property window.

3. Figure 28-5 Descriptor Info Tab, Comment Field

   
   Description of "Figure 28-5 Descriptor Info Tab, Comment Field"
   
   

In the Comment field, enter a description of this descriptor.