TOC PREV NEXT INDEX DOC LIST MASTER INDEX




Rose > C++ > Annotate

Note: This command/product is only available for Apex C++ and Apex Duo.

The Rose > C++ > Annotate command is used before a source file is reverse-engineered for the first time.

To preserve design specifications of the model in the source file, Rose produces special design annotations in source files in the code generation. These annotations help record the design documentations, keep different kinds of specifications in separate regions, and protect them through reverse engineering.

For an existing C++ source file that does NOT contain Rose design annotations, the Rose > C++ > Annotate command can be used to insert the annotation in the file. This is done only for the first time when the file is being reverse-engineered. Once the annotations are inserted into the source files, the subsequent round-trip engineering can be handled easily.

To annotate a set of source file(s) in the view from an Apex directory viewer:

1. . Select all the source files for annotation. If the view name is selected, tall the C++ source files in this view are included in the selection.

2. . Click on Rose > C++ > Annotate.

To annotate a file from an Apex editor window, simply click on Rose > C++ > Annotate.

This command completes the following actions:

1. . Checks whether a project file already exists for the selected file(s). If it does, skips to Step 4.

2. . Brings up the Rose Analyzer, if it is not already running.

3. . If the project file containing the selected file(s) does not exist, the Rose Analyzer builds it.

4. . The Rose Analyzer applies annotation insertions to the files listed in the project file.

The messages for this process are displayed in the Apex Message window and the Log windows of Rose and Rose Analyzer. The selected source file(s) can then be examined for the inserted annotations.

Note: Note. A design annotation is a C++ structured comment of the form of "//## <verb>: <parameter>".

Rose Developer is a layered product for Apex. It is described in detail in the Rose Developer User's Guide.

Additional Topics

For more information, click on a topic:


Rational Software Corporation 
http://www.rational.com
support@rational.com
techpubs@rational.com
Copyright © 1993-2001, Rational Software Corporation. All rights reserved.
TOC PREV NEXT INDEX DOC LIST MASTER INDEX TECHNOTES APEX TIPS