Changing the appearance of Javadoc comments in generated code
About this task
The appearance of Javadoc comments in the
generated code is determined by the documentation templates defined
using the various DescriptionTemplate properties.
To change these templates:
Procedure
Examine the content that JavaDocProfile
provides for the various DescriptionTemplate properties.
Modify the values of these properties to
match the appearance you would like.
Results
When changing these properties, keep in
mind the following items:
Use new lines to indicate where you would like IBM® Rational® Rhapsody® to
begin a new line. You can only see such line breaks by using the .. button to open the text editor for the property.
In the default content that JavaDocProfile provides
for the DescriptionTemplate properties, you can use
the characters [[ ]] in your template definitions. If you enclose
part of the definition in these brackets, Rational Rhapsody generates
only the relevant Javadoc tag, for example, @version,
if content has been provided for that tag for the element in question.