summaryrefslogtreecommitdiffstats
path: root/doc/tools/pdl2texi/s.d
blob: a434bf4523d61f19d466c268568b5384ec3753fe (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

OBJECT: Object_name
  DESCRIPTION:
    This object ...
    (briefly describe the object's primary responsibility or purpose)
  COPYRIGHT:
    Copyright (c) 1995, On-Line Applications Research Corporation (OAR)
  PORTING:
  THEORY OF OPERATION:
  DERIVATION:
  DEPENDENCIES:
  NOTES:

ATTRIBUTE DESCRIPTIONS:

ATTRIBUTE: An_attribute
  DESCRIPTION:
    This attribute ...
    (briefly describe the attribute's primary purpose)
  TYPE: float [constant]|integer [constant]
    (indicate one of the above)
  RANGE|MEMBERS: 0 - +INFINITY  or  MEMBER1, MEMBER2, MEMBER3
    (indicate RANGE or MEMBERS and specify, MEMBERS should be listed
     in all caps, RANGE can use +/-INFINITY)
  UNITS:
  SCALE FACTOR:
  DEFAULTS:
  TOLERANCE:
  REQUIREMENTS:
    ABCD 3.2.4 A paragraph title
    (indicate document, paragraph number, paragraph title)
  REFERENCES:
  NOTES:

ASSOCIATION DESCRIPTIONS:

ASSOCIATION:
  DESCRIPTION:
  VISIBILTY:
  ASSOCIATED WITH:
  MULTIPLICITY:
  REQUIREMENTS:
    ABCD 3.2.4 A paragraph title
    (indicate document, paragraph number, paragraph title)
  REFERENCES:
  NOTES:  

ABSTRACT TYPE DESCRIPTIONS:

ABSTRACT TYPE:
  DESCRIPTION:
    This type ...
    (briefly describe the type's primary purpose)
  VISIBILITY: private|public
    (indicate one of the above)
  DERIVATION:  
  MEMBERS|RANGE:  0 - +INFINITY  or  MEMBER1, MEMBER2, MEMBER3
    (indicate RANGE or MEMBERS and specify, MEMBERS should be listed
     in all caps, RANGE can use +/-INFINITY)
  UNITS:
  SCALE FACTOR:
  DEFAULTS:
  TOLERANCE:
  REQUIREMENTS:
    ABCD 3.2.4 A paragraph title
    (indicate document, paragraph number, paragraph title)
  REFERENCES:
  NOTES:

DATA ITEM DESCRIPTIONS:

DATA ITEM:
  DESCRIPTION:
    This data item ...
    (briefly describe the data item's primary purpose)
  TYPE:
  UNITS:
  SCALE FACTOR:
  DEFAULTS:
  TOLERANCE:
  NOTES:

METHODS DESCRIPTIONS:
  (List methods alphabetically grouping public methods followed
   by private methods.)

METHOD: Some_method
  DESCRIPTION:
    This method ...
    (briefly describe the method's primary responsibility)
  VISIBILITY: private|public
    (indicate one of the above)
  INPUTS:
    input_one - the first and only input
    (specify the logical inputs followed by a description,
     indicate 'none' if there are no inputs)
  OUTPUTS:
    output_one - the first and only output
    (specify the logical outputs followed by a description,
     indicate 'none' if there are no outputs, use 'result' if the
     method is a boolean function)
  REQUIREMENTS:
    ABCD 3.2.4 A paragraph title
    (indicate document, paragraph number, paragraph title)
  REFERENCES:
  NOTES:
  PDL:

TASK DESCRIPTIONS:

TASK:
  DESCRIPTION:
    This task ...
    (briefly describe the task's primary responsibility)
  INPUTS:
  SYNCHRONIZATION: delay|event|message|semaphore|signal|period
    (indicate one or more of the above and list any events,
     messages, or signals that can be received)
  TIMING:
    (specify any timing information that is related to the
     synchronization specified above)
  REQUIREMENTS:
    ABCD 3.2.4 A paragraph title
    (indicate document, paragraph number, paragraph title)
  REFERENCES:
  NOTES:
  PDL:

ENDOBJECT: Object_name