@Description

Tags: not added yet

@Description

This annotation summarizes information about the component, including purpose and scientific background. The annotation can be read by archiving and document management tools. The information facilitates component library searches. Modelers can use the information to aid selecting components to include in a model.

The annotation should not exceed a few sentences. More extensive context information should be included in the @Documentation annotation.

Synopsis

@Description(<String>)

arg - the description paragraph

The description can be localized for different languages. Add the ISO language code (http:// ftp.ics.uci.edu/pub/ietf/http/related/iso639.txt) to provide description in a different language. Description for multiple languages is supported.

Type

Documentation Annotation

Scope

Subroutine, Variable

Example

The following example demonstrates the use of the @Description annotation for both the component (class) and variable (field).


!  @Description("CSMLite Plant Component")
...
!  @Execute 
SUBROUTINE Plant

    USE, INTRINSIC :: ISO_C_BINDING
    IMPLICIT NONE
...
!  @Description("Daily maximum temperature in degrees Centigrade")
!  @In 
   REAL TMAX
...

Navigation Bar for Object Modeling System

- Menu is not available…

Resources:

Downloads
You must login to see this link. Register now, if you have no user account yet.

OMS API Javadoc

Publications & Presentations

Annotation Reference

DSL Reference
Handbook 3.0 (Draft)

Frequently Asked Questions (FAQ)

OMS License (LGPL 2.1)

New Users:
1. Get an ALM account
2. Join the OMS project

Contact Us:

Jack Carlson
Coordinator, OMS Laboratory
OMS Laboratory

Jack.Carlson@colostate.edu
(970) 492-7323

Olaf David

Director, OMS Laboratory
odavid (at) colostate.edu
(970) 491-8026