From 4f63bf139f085522ce1ab7d629076fef0f67fa9c Mon Sep 17 00:00:00 2001
From: Saeed Haghtalab <saeed.haghtalab@esss.se>
Date: Fri, 6 Sep 2019 14:36:36 +0200
Subject: [PATCH 1/2] Rename stateRecord.dbd -> stateRecord.dbd.pod

---
 src/std/rec/{stateRecord.dbd => stateRecord.dbd.pod} | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename src/std/rec/{stateRecord.dbd => stateRecord.dbd.pod} (100%)

diff --git a/src/std/rec/stateRecord.dbd b/src/std/rec/stateRecord.dbd.pod
similarity index 100%
rename from src/std/rec/stateRecord.dbd
rename to src/std/rec/stateRecord.dbd.pod

From 0d3cc5a20a41fc7af4004585a9555d01d482e211 Mon Sep 17 00:00:00 2001
From: Saeed Haghtalab <saeed.haghtalab@esss.se>
Date: Fri, 6 Sep 2019 15:03:23 +0200
Subject: [PATCH 2/2] Added POD to state record with a note that it is
 deprecated

---
 src/std/rec/stateRecord.dbd.pod | 99 +++++++++++++++++++++++++++++++++
 1 file changed, 99 insertions(+)

diff --git a/src/std/rec/stateRecord.dbd.pod b/src/std/rec/stateRecord.dbd.pod
index 6e43ddbba..8734f01bd 100644
--- a/src/std/rec/stateRecord.dbd.pod
+++ b/src/std/rec/stateRecord.dbd.pod
@@ -6,8 +6,93 @@
 # EPICS BASE is distributed subject to a Software License Agreement found
 # in file LICENSE that is included with this distribution.
 #*************************************************************************
+
+=head1 State Record (state)
+
+The state record is a means for a state program to communicate with the operator
+interface. Its only function is to provide a place in the database through which
+the state program can inform the operator interface of its state by storing an
+arbitrary ASCII string in its VAL field.
+
+B<Note that this record is deprecated and will probably be removed from future EPICS base releases.>
+
+=head2 Contents
+
+=over
+
+=item * L<Parameter Fields>
+
+=over
+
+=item * L<Operator Display Parameters>
+
+=item * L<Alarm Parameters>
+
+=item * L<Run-time Parameters>
+
+=back
+
+=item * L<Record Support>
+
+=over
+
+=item * L<Record Support Routines (stateRecord.c)>
+
+=back
+
+=back
+
+=begin html
+
+<br>
+<hr>
+<br>
+
+=end html
+
+=recordtype state
+
+=cut
+
 recordtype(state) {
 	include "dbCommon.dbd" 
+
+=head2 Parameter Fields
+
+=head3 Scan Parameters
+
+The state record has the standard fields for specifying under what circumstances
+it will be processed. These fields are listed in 
+L<Scan Fields|https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14_dbCommon#Scan_Fields>. 
+In addition,
+L<Scanning Specification|https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14_Concepts#Scanning_Specification> 
+explains how these fields are used.
+
+=head3 Operator Display Parameters
+
+See L<Fields Common to All Record Types|https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14_dbCommon#Fields_Common_to_All_Record_Types> 
+for more on the record name (NAME) and description (DESC) fields.
+
+=fields NAME, DESC
+
+=head3 Alarm Parameters
+
+The state record has the alarm parameters common to all record types.  
+L<Alarm Fields|https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14_dbCommon#Alarm_Fields> 
+lists other fields related to a alarms that are common to all record types.
+
+=head3 Run-time Parameters
+
+These parameters are used by the application code to convey the state of the
+program to the operator interface. The VAL field holds the string retrieved from
+the state program. The OVAL is used to implement monitors for the VAL field.
+When the string in OVAL differs from the one in VAL, monitors are triggered.
+They represent the current state of the sequence program. 
+
+=fields VAL, OVAL
+
+=cut
+
 	field(VAL,DBF_STRING) {
 		prompt("Value")
 		promptgroup("40 - Input")
@@ -21,4 +106,18 @@ recordtype(state) {
 		interest(3)
 		size(20)
 	}
+
+=head2 Record Support
+
+=head3 Record Support Routines (stateRecord.c)
+
+=head4 process
+
+  long (*process)(struct dbCommon *precord)
+
+process triggers monitors on VAL when it changes and scans the forward link if
+necessary.
+
+=cut
+
 }