epics/epics-base
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

Many edits to record reference docs

Browse Source 
Add documentation for aSub from wiki.
Fix incorrect document structures.
Remove inclusion of menu.dbd files.
Fix links to common doc's, remove some links to nowhere.
Adjust podToHtml.pl and the rule that calls it.
This commit is contained in:
Andrew Johnson
2020-05-26 21:49:35 -05:00
parent 1f4e812223
commit dd1b65f32c
34 changed files with 856 additions and 586 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
modules/database/src/std/rec/subArrayRecord.dbd.pod
View File

@@ -36,17 +36,14 @@ The record-specific fields are described below, grouped by functionality.
=head3 Scan Parameters
The subArray record has the standard fields for specifying under what
circumstances the record will be processed. These fields are listed in
L<Scan Fields>.
In addition, L<Scanning Specification> explains how these fields are used.
circumstances the record will be processed.
These fields are listed in L<Scan Fields|dbCommonRecord/Scan Fields>.
=head3 Read Parameters
The subArray's input link (INP) should be configured to reference the Waveform
record. It should specify the VAL field of a Waveform record. The INP field can
be a channel access link, in addition to a database link. See
L<Address Specification>
for information on specifying links.
be a channel access link, in addition to a database link.
In addition, the DTYP field must specify a device support module. Currently, the
only device support module is C<Soft Channel>.
@@ -94,16 +91,16 @@ The PREC field determines the floating point precision with which to display
VAL. It is used whenever the C<get_precision()> record support routine is
called.
See L<Fields Common to All Record Types>
for more on the record name (NAME) and description (DESC) fields.
See L<Fields Common to All Record Types|dbCommonRecord/Operator Display
Parameters> for more on the record name (NAME) and description (DESC) fields.
=fields EGU, HOPR, LOPR, PREC, NAME, DESC
=head3 Alarm Parameters
The subarray record has the alarm parameters common to all record types.
L<Alarm Fields> lists other fields related to a alarms that are common to all
record types.
L<Alarm Fields|dbCommonRecord/Alarm Fields> lists the fields related to
alarms that are common to all record types.
=head3 Run-time Parameters
@@ -144,7 +141,7 @@ C<init_record()>, it is called.
long (*process)(struct dbCommon *precord)
See L<Record Processing>.
See L</"Record Processing">.
=head4 cvt_dbaddr