The C_CG::File::SpecificationHeader property
specifies the multiline header to be generated at the beginning of
specification files.
The
default
content for the SpecificationHeader property
in C is as follows:
/*******************************************************
Rational Rhapsody Developer for C : $Rational RhapsodyVersion
Login : $Login
Component : $ComponentName
Configuration : $ConfigurationName
Model Element : $FullModelElementName
//! Generated Date : $CodeGeneratedDate
File Path : $FullCodeGeneratedFileName
*******************************************************/
Header format strings can contain any
of the following
keywords:
- $ProjectName for
the project name.
- $ComponentName for
the component
name (for example, HelloWorld).
- $ConfigurationName for
the configuration
name (for example, HelloWorld).
- $ModelElementName for
the name
of the element mapped to the file. If there is more than one, this
is the name of the first element.
- $FullModelElementName for
the
name of the element mapped to the file (for example, Default),
including the full path. If there is more than one, this is the name
of the first element.
- $CodeGeneratedDate for
the generation
date.
- $CodeGeneratedTime for
the generation
time.
- $Rational RhapsodyVersion for
the version of IBM® Rational® Rhapsody® that
generated the file (for example, 7.5).
- $Login for
the user who generated
the file.
- $CodeGeneratedFileName for
the
name of the generated file.
- $FullCodeGeneratedFileName for
the full file name (for example, HelloWorld\Default.h).
- $Tag for the value of the tag
for the specified element.
- $Property for
the value of the
element property with the specified name.
To
avoid redundant compilation, Rational Rhapsody avoids
unnecessary changes to specific lines prefixed with a special string,
defined by the C_CG::File::DiffDelimiter property.
The default DiffDelimiter value is //!.
The keywords are resolved in the following order:
- Predefined keywords (such as $Name)
- Property keywords
- Tag keywords
Note the following:
- Keyword
names can be written in parentheses. For
example:
$(Name)
- If the value of a keyword is a
MultiLine, each
new line (except the first one) starts with the value of the C_CG::Configuration::DescriptionBeginLine property;
each line ends with the value of the C_CG::Configuration::DescriptionEndLine property.