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

15
modules/database/src/std/rec/printfRecord.dbd.pod
View File

@@ -24,8 +24,8 @@ recordtype(printf) {
=head3 Scan Parameters
The printf record has the standard fields for specifying under what
circumstances it will be processed. These fields are listed in L<Scan Fields>.
In addition, L<Scanning Specification> explains how these fields are used.
circumstances it will be processed.
These fields are listed in L<Scan Fields|dbCommonRecord/Scan Fields>.
=head3 String Generation Parameters
@@ -154,8 +154,6 @@ The output link specified in the OUT field specifies where the printf record is
to write the contents of its VAL field. The link can be a database or channel
access link. If the OUT field is a constant, no output will be written.
See L<Address Specification> for information on specifying links.
In addition, the appropriate device support module must be entered into the DTYP
field.
@@ -163,8 +161,9 @@ field.
=head3 Operator Display Parameters
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 NAME, DESC
@@ -217,8 +216,8 @@ description (DESC) fields.
=head3 Alarm Parameters
The printf 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.
The IVLS field specifies a string which is sent to the OUT link if if input
link data are invalid.