Programmer's Guide, aproc added

src/doc/prm/src/doxygen.dx

@@ -25,6 +25,7 @@ This manual will give a description of the following API's
 - Errh Print messages on system log.
 - Sevcli Storage environment client interface.
 - NMps Interface to NMps Cell objects.
+- AProc Application process interface.
 - rt_appl A base class for applications i c++.
 */
 
@@ -330,6 +331,11 @@ This manual will give a description of the following API's
   This module contains interface functions for application access to NMps.
 */
 
+/*! \defgroup AProc AProc Application process interface
+  \ingroup PRM
+  This module contains functions to handle application processes.
+*/
+
 /*! \defgroup rt rt_appl Base class for applications
   \ingroup PRM
   rt_appl is a base class for c++ applications.

src/doc/prm/src/os_templ/hw_templ/Doxyfile

@@ -591,6 +591,8 @@ INPUT                  = $(pwre_sroot)/doc/prm/src/doxygen.dx \
                          $(pwre_sroot)/lib/rt/src/rt_qcom.h \
                          $(pwre_sroot)/lib/rt/src/rt_sevcli.h \
                          $(pwre_croot)/nmps/lib/nmps/src/nmps_appl.h \
+                         $(pwre_sroot)/lib/rt/src/rt_aproc.h \
+                         $(pwre_sroot)/lib/rt/src/rt_aproc.c \
                          $(pwre_sroot)/lib/rt/src/rt_appl.h \
                          $(pwre_sroot)/lib/rt/src/rt_appl.cpp \
                          $(pwre_sroot)/lib/co/src/co_time.c \

src/lib/rt/src/rt_aproc.c

@@ -46,6 +46,13 @@
 static pwr_sNode *proc_np = 0;
 
 
+/**
+ * @brief Register Application object.
+ * The Application object is stored in the $Node object and be opened from the node graph.
+ *
+ *    \param oid	Objid for Application object.
+ *    \return           Status or operation.
+ */
 pwr_tStatus aproc_RegisterObject( 
   pwr_tOid oid
 )
@@ -69,6 +76,15 @@ pwr_tStatus aproc_RegisterObject(
   return PROC__SUCCESS;
 }
 
+/**
+ * @brief Set application timestamp.
+ * The timestamp is supervised by the event monitor and if the timestamp is delayed more
+ * than the max delay, timeout status is set for the process.
+ *
+ *    \param cycletime	Application cycle time in seconds.
+ *    \param maxdelay	Max delay in seconds.
+ *    \return           Status or operation.
+ */
 pwr_tStatus aproc_TimeStamp( float cycletime, float maxdelay)
 {
   pwr_tStatus sts;

src/lib/rt/src/rt_aproc.h

@@ -44,9 +44,14 @@ extern "C" {
 #include "pwr.h"
 #include "rt_errh.h"
 
+/** @addtogroup AProc */
+/*@{*/
+
 pwr_tStatus	aproc_RegisterObject(pwr_tOid);
 pwr_tStatus	aproc_TimeStamp( float scantime, float maxdelay);
 
+/** @} */
+
 #if defined __cplusplus
 }
 #endif