---
 src/plm/agent/plma_api.c  | 1837 ++++++---------------------------------------
 src/plm/agent/plma_comm.c |   66 +-
 src/plm/agent/plma_init.c |  291 ++-----
 src/plm/agent/plma_mds.c  |  164 +---
 4 files changed, 341 insertions(+), 2017 deletions(-)

diff --git a/src/plm/agent/plma_api.c b/src/plm/agent/plma_api.c
index 596175e..8203e2b 100644
--- a/src/plm/agent/plma_api.c
+++ b/src/plm/agent/plma_api.c
@@ -12,55 +12,16 @@
  * licensing terms.
  *
  * Author(s): Emerson Network Power
- *
+ *            High Availability Solutions Pvt. Ltd.
  */
-/*************************************************************************/ /**
-                                                                            * 
@file
-                                                                            
*plma_api.c
-                                                                            * 
@brief
-                                                                            
*This
-                                                                            
*file
-                                                                            
*contains
-                                                                            
*the
-                                                                            
*APIs
-                                                                            
*which
-                                                                            
*are
-                                                                            
*needed
-                                                                            *to
-                                                                            *be
-                                                                            
*supported
-                                                                            *by
-                                                                            *  
        agent
-                                                                            *in
-                                                                            
*order
-                                                                            
*for
-                                                                            
*the
-                                                                            
*client
-                                                                            *to
-                                                                            
*communicate
-                                                                            
*with
-                                                                            
*PLM
-                                                                            
*service.
-                                                                            *  
        All
-                                                                            
*the
-                                                                            
*below
-                                                                            
*calls
-                                                                            
*will
-                                                                            *be
-                                                                            
*implemented
-                                                                            *as
-                                                                            
*sync
-                                                                            
*calls
-                                                                            
*from
-                                                                            
*Agent
-                                                                            *  
        to
-                                                                            
*Server.
-                                                                            *
-                                                                            * 
@author
-                                                                            
*Emerson
-                                                                            
*Network
-                                                                            
*Power
-                                                                            
*****************************************************************************/
+/*************************************************************************
+* @file  : plma_api.c
+* @brief : This file contains the APIs which are needed to be supported by
+*         agent in order for the client to communicate with PLM service.All
+*         the below calls will be implemented as sync calls from Agent
+*         to Server.
+* @author: Emerson Network Power
+*****************************************************************************/
 
 #include "plma.h"
 
@@ -93,63 +54,16 @@
 uint32_t plm_process_dispatch_cbk(PLMA_CLIENT_INFO *client_info,
                                  SaDispatchFlagsT flags);
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          
*Routine
-                                                                          *for
-                                                                          
*freeing
-                                                                          
*entities
-                                                                          
*allocated
-                                                                          *in a
-                                                                          
*previous
-                                                                          *call
-                                                                          *to
-                                                                          *    
        the
-                                                                          
*saPlmReadinessTrack()
-                                                                          *
-                                                                          * 
@param[in,out]
-                                                                          
*listHead
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          *head
-                                                                          *of
-                                                                          *the
-                                                                          *list
-                                                                          *of
-                                                                          
*array
-                                                                          *of
-                                                                          *    
                        entities
-                                                                          
*added
-                                                                          *by
-                                                                          
*using
-                                                                          
*SaPlmReadinessTrack()
-                                                                          *    
                        function.
-                                                                          * 
@param[in]
-                                                                          
*entities
-                                                                          *A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*array
-                                                                          *of
-                                                                          
*entities
-                                                                          *that
-                                                                          *was
-                                                                          *    
                        allocated
-                                                                          *by
-                                                                          *the
-                                                                          *PLM
-                                                                          
*Service
-                                                                          
*library
-                                                                          *in
-                                                                          *the
-                                                                          *    
                        SaPlmReadinessTrack()
-                                                                          
*function.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief       : Routine for freeing entities allocated in a previous call to
+*                 the saPlmReadinessTrack()
+* @param[in,out]: listHead pointer to the head of the list of array of
+*                 entities added by using SaPlmReadinessTrack() function.
+* @param[in]    : entities: A pointer to the array of entities that was
+*                 allocated by the PLM Service library in the
+*                 SaPlmReadinessTrack() function.
+* @return       : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 SaAisErrorT plm_add_entity_addr_to_list(PLMA_RDNS_TRK_MEM_LIST **listHead,
                                        SaPlmReadinessTrackedEntityT *entities)
 {
@@ -181,40 +95,12 @@ SaAisErrorT 
plm_add_entity_addr_to_list(PLMA_RDNS_TRK_MEM_LIST **listHead,
        return NCSCC_RC_SUCCESS;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          
*invokes
-                                                                          *a
-                                                                          
*single
-                                                                          
*pending
-                                                                          
*callback
-                                                                          *in
-                                                                          *the
-                                                                          
*context
-                                                                          *    
        calling
-                                                                          
*thread,
-                                                                          *and
-                                                                          *then
-                                                                          
*return
-                                                                          *from
-                                                                          *the
-                                                                          
*dispatch.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*client_info
-                                                                          *-
-                                                                          *A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*PLMA_CLIENT_INFO
-                                                                          
*structure.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***************************************************************************
+* @brief    : This routine invokes a single pending callback in the context
+*            calling thread, and then return from the dispatch.
+* @param[in]: client_info - A pointer to the PLMA_CLIENT_INFO structure.
+* @return   : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plm_process_single_dispatch(PLMA_CLIENT_INFO *client_info)
 {
        uint32_t proc_rc = NCSCC_RC_SUCCESS;
@@ -299,45 +185,13 @@ end:
        return proc_rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          
*invokes
-                                                                          *all
-                                                                          *of
-                                                                          *the
-                                                                          
*pending
-                                                                          
*callbacks
-                                                                          *in
-                                                                          *the
-                                                                          *    
        context
-                                                                          *of
-                                                                          *the
-                                                                          
*calling
-                                                                          
*thread
-                                                                          *if
-                                                                          
*callbacks
-                                                                          *are
-                                                                          
*pending
-                                                                          
*before
-                                                                          *    
        returning
-                                                                          *from
-                                                                          
*dispatch.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*client_info
-                                                                          *-
-                                                                          *A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*PLMA_CLIENT_INFO
-                                                                          
*structure.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/*****************************************************************************
+* @brief    : This routine invokes all of the pending callbacks in the context
+*            of the calling thread if callbacks are pending before returning
+*            from dispatch.
+* @param[in]: client_info - A pointer to the PLMA_CLIENT_INFO structure.
+* @return   : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plm_process_dispatch_all(PLMA_CLIENT_INFO *client_info)
 {
        uint32_t proc_rc = NCSCC_RC_SUCCESS;
@@ -422,60 +276,14 @@ uint32_t plm_process_dispatch_all(PLMA_CLIENT_INFO 
*client_info)
        return proc_rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *One
-                                                                          *or
-                                                                          *more
-                                                                          
*threads
-                                                                          
*calling
-                                                                          
*dispatch
-                                                                          
*remain
-                                                                          
*within
-                                                                          
*dispatch
-                                                                          *    
        and
-                                                                          
*execute
-                                                                          
*callbacks
-                                                                          *as
-                                                                          *they
-                                                                          
*become
-                                                                          
*pending.
-                                                                          *The
-                                                                          
*thread
-                                                                          *or
-                                                                          *    
        threads
-                                                                          *do
-                                                                          *not
-                                                                          
*return
-                                                                          *from
-                                                                          
*dispatch
-                                                                          
*until
-                                                                          *the
-                                                                          
*corresponding
-                                                                          *    
        finalize
-                                                                          
*function
-                                                                          *is
-                                                                          
*executed
-                                                                          *by
-                                                                          *one
-                                                                          
*thread
-                                                                          *of
-                                                                          *the
-                                                                          
*process.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*client_info
-                                                                          *-
-                                                                          *A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*PLMA_CLIENT_INFO
-                                                                          
*structure
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/******************************************************************************
+* @brief    : One or more threads calling dispatch remain within dispatch and
+*            execute callbacks as they become pending.The thread or threads do
+*            not return from dispatch until the corresponding finalize function
+*            is executed by one thread of the process.
+* @param[in]: client_info - A pointer to the PLMA_CLIENT_INFO structure
+* @return   : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+*******************************************************************************/
 uint32_t plm_process_blocking_dispatch(PLMA_CLIENT_INFO *client_info)
 {
        uint32_t proc_rc = NCSCC_RC_SUCCESS;
@@ -556,43 +364,12 @@ uint32_t plm_process_blocking_dispatch(PLMA_CLIENT_INFO 
*client_info)
        return proc_rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          
*Routine
-                                                                          *to
-                                                                          
*despatch
-                                                                          *the
-                                                                          *call
-                                                                          *back
-                                                                          
*based
-                                                                          *on
-                                                                          *the
-                                                                          
*flags.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*client_info
-                                                                          *-
-                                                                          *A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*PLMA_CLIENT_INFO
-                                                                          
*structure.
-                                                                          * 
@param[in]
-                                                                          
*flags
-                                                                          *-
-                                                                          
*Flags
-                                                                          *to
-                                                                          
*specify
-                                                                          *the
-                                                                          *call
-                                                                          *back
-                                                                          
*execution
-                                                                          *    
                        behavior.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/**************************************************************************
+* @brief    : Routine to dispatch the call back based on the flags.
+* @param[in]: client_info - A pointer to the PLMA_CLIENT_INFO structure.
+* @param[in]: flags - Flags to specify the call back execution behavior.
+* @return   : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plm_process_dispatch_cbk(PLMA_CLIENT_INFO *client_info,
                                  SaDispatchFlagsT flags)
 {
@@ -617,116 +394,21 @@ uint32_t plm_process_dispatch_cbk(PLMA_CLIENT_INFO 
*client_info,
        return proc_rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*initializes
-                                                                          *the
-                                                                          *PLM
-                                                                          
*Service
-                                                                          *for
-                                                                          *the
-                                                                          *    
                invoking
-                                                                          
*process
-                                                                          *and
-                                                                          
*registers
-                                                                          *the
-                                                                          
*various
-                                                                          
*callback
-                                                                          *    
                functions.
-                                                                          *The
-                                                                          
*handle
-                                                                          
*'plmHandle'
-                                                                          *is
-                                                                          
*returned
-                                                                          *as
-                                                                          *the
-                                                                          *    
                reference
-                                                                          *to
-                                                                          *this
-                                                                          
*association
-                                                                          
*between
-                                                                          *the
-                                                                          
*process
-                                                                          *and
-                                                                          *    
                the
-                                                                          *PLM
-                                                                          
*Service.
-                                                                          *
-                                                                          * 
@param[out]
-                                                                          
*plmHandle
-                                                                          *-
-                                                                          *A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*handle
-                                                                          
*designating
-                                                                          *this
-                                                                          *    
                                particular
-                                                                          
*initialization
-                                                                          *of
-                                                                          *the
-                                                                          *PLM
-                                                                          *    
                                service,
-                                                                          *that
-                                                                          *is
-                                                                          *to
-                                                                          *be
-                                                                          
*returned
-                                                                          *by
-                                                                          *the
-                                                                          *    
                                PLM
-                                                                          
*service.
-                                                                          * 
@param[in]
-                                                                          
*plmCallbacks
-                                                                          *-
-                                                                          
*Pointer
-                                                                          *to a
-                                                                          
*SaPlmCallbacksT
-                                                                          
*structure,
-                                                                          *    
                                containing
-                                                                          *the
-                                                                          
*callback
-                                                                          
*functions
-                                                                          *of
-                                                                          *    
                                the
-                                                                          
*process
-                                                                          *that
-                                                                          *the
-                                                                          *PLM
-                                                                          
*Service
-                                                                          *may
-                                                                          *    
                                invoke.
-                                                                          * 
@param[in,out]
-                                                                          
*version
-                                                                          *-  A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*version
-                                                                          *of
-                                                                          *the
-                                                                          *PLM
-                                                                          *    
                                service
-                                                                          *that
-                                                                          *the
-                                                                          
*invoking
-                                                                          
*process
-                                                                          *    
                                is
-                                                                          
*using.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          *    
                values.
-                                                                          
***************************************************************************/
+/***************************************************************************
+* @brief        : This function initializes the PLM Service for the invoking
+*                process and registers the various callback functions.
+*                The handle 'plmHandle' is returned as the reference to this
+*                association between the process and the PLM Service.
+* @param[out]   : plmHandle - A pointer to the handle designating this
+*                particular initialization of the PLM service,that is to be
+*                returned by the PLM service.
+* @param[in]    : plmCallbacks - Pointer to a SaPlmCallbacksT structure,
+*                containing the callback functions of the process that the
+*                PLM Service may invoke.
+* @param[in,out]: version -  A pointer to the version of the PLM service that
+*                the invoking process is using.
+* @return       : Refer to SAI-AIS specification for various return values.
+***************************************************************************/
 SaUint32T saPlmInitialize(SaPlmHandleT *plmHandle,
                          const SaPlmCallbacksT *plmCallbacks,
                          SaVersionT *version)
@@ -916,75 +598,16 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*returns
-                                                                          *the
-                                                                          
*operating
-                                                                          
*system
-                                                                          
*handle
-                                                                          
*associated
-                                                                          *    
        with
-                                                                          *the
-                                                                          
*handle
-                                                                          
*plmHandle.
-                                                                          *
-                                                                          * 
@param[out]
-                                                                          
*plmHandle
-                                                                          *-  A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*handle
-                                                                          
*designating
-                                                                          *this
-                                                                          *    
                           particular
-                                                                          
*initialization
-                                                                          *of
-                                                                          *the
-                                                                          *PLM
-                                                                          
*service
-                                                                          *    
                           that
-                                                                          *is
-                                                                          *to
-                                                                          *be
-                                                                          
*returned
-                                                                          *by
-                                                                          *the
-                                                                          *PLM
-                                                                          
*service.
-                                                                          * 
@param[out]
-                                                                          
*selectionObject
-                                                                          *-  A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*Operating
-                                                                          
*system
-                                                                          
*handle
-                                                                          *    
                           that
-                                                                          *the
-                                                                          
*process
-                                                                          *can
-                                                                          *use
-                                                                          *to
-                                                                          
*detect
-                                                                          *the
-                                                                          *    
                           pending
-                                                                          
*callbacks.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          
*values.
-                                                                          
***************************************************************************/
+/*************************************************************************
+* @brief     : This function returns the operating system handle associated 
with
+*              the handle plmHandle.
+* @param[out]: plmHandle -  A pointer to the handle designating this particular
+*              initialization of the PLM service that is to be returned by the
+*             PLM service.
+* @param[out]: selectionObject -  A pointer to the Operating system handle that
+*             the process can use to detect the pending callbacks.
+* @return    : Refer to SAI-AIS specification for various return values.
+***************************************************************************/
 SaUint32T saPlmSelectionObjectGet(SaPlmHandleT plmHandle,
                                  SaSelectionObjectT *selectionObject)
 {
@@ -1047,90 +670,18 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *In
-                                                                          *the
-                                                                          
*context
-                                                                          *of
-                                                                          *the
-                                                                          
*calling
-                                                                          
*thread,
-                                                                          *this
-                                                                          
*function
-                                                                          
*invokes
-                                                                          *    
        pending
-                                                                          
*callbacks
-                                                                          *for
-                                                                          *the
-                                                                          
*handle
-                                                                          
*plmHandle
-                                                                          *in a
-                                                                          *way
-                                                                          *that
-                                                                          *is
-                                                                          *    
        specified
-                                                                          *by
-                                                                          *the
-                                                                          
*dispatchFlags
-                                                                          
*parameter.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*plmHandle
-                                                                          *-  A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*handle
-                                                                          
*designating
-                                                                          *this
-                                                                          *    
                        particular
-                                                                          
*initialization
-                                                                          *of
-                                                                          *the
-                                                                          *PLM
-                                                                          
*service
-                                                                          *    
                         that
-                                                                          *is
-                                                                          *to
-                                                                          *be
-                                                                          
*returned
-                                                                          *by
-                                                                          *the
-                                                                          *PLM
-                                                                          
*service.
-                                                                          * 
@param[in]
-                                                                          
*flags
-                                                                          *-
-                                                                          
*Flags
-                                                                          *that
-                                                                          
*specify
-                                                                          *the
-                                                                          
*callback
-                                                                          
*execution
-                                                                          *    
                        behavior
-                                                                          *of
-                                                                          *the
-                                                                          
*saPlmDispatch()
-                                                                          
*function,
-                                                                          
*which
-                                                                          *    
                        have
-                                                                          
*thevalues
-                                                                          
*SA_DISPATCH_ONE,
-                                                                          
*SA_DISPATCH_ALL
-                                                                          *    
                        or
-                                                                          
*SA_DISPATCH_BLOCKING.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          
*values.
-                                                                          
***************************************************************************/
+/************************************************************************
+* @brief    : In the context of the calling thread, this function invokes
+*            pending callbacks for the handle plmHandle in a way that is
+*            specified by the dispatchFlags parameter.
+* @param[in]: plmHandle -  A pointer to the handle designating this particular
+*            initialization of the PLM service that is to be returned by the
+*            PLM service.
+* @param[in]: flags - Flags that specify the callback execution behavior of the
+*            saPlmDispatch() function,which have the values SA_DISPATCH_ONE,
+*            SA_DISPATCH_ALL or SA_DISPATCH_BLOCKING.
+* @return   : Refer to SAI-AIS specification for various return values.
+***************************************************************************/
 SaAisErrorT saPlmDispatch(SaPlmHandleT plmHandle, SaDispatchFlagsT flags)
 {
        PLMA_CB *plma_cb = plma_ctrlblk;
@@ -1181,41 +732,12 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          
*Cleans
-                                                                          *up
-                                                                          *the
-                                                                          
*client
-                                                                          *info
-                                                                          *node
-                                                                          *when
-                                                                          *the
-                                                                          
*service
-                                                                          *is
-                                                                          
*finalized.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*client_node
-                                                                          *-  A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*PLMA_CLIENT_INFO
-                                                                          
*structure
-                                                                          *    
                        which
-                                                                          
*needs
-                                                                          *to
-                                                                          *be
-                                                                          
*cleaned
-                                                                          
*before
-                                                                          
*freeing
-                                                                          *it.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Returns
-                                                                          
*nothing.
-                                                                          
***************************************************************************/
+/***************************************************************************
+* @brief    : Cleans up the client info node when the service is finalized.
+* @param[in]: client_node -  A pointer to the PLMA_CLIENT_INFO structure which
+*            needs to be cleaned before freeing it.
+* @return   : Returns nothing.
+***************************************************************************/
 void clean_client_info_node(PLMA_CLIENT_INFO *client_node)
 {
        PLMA_CB *plma_cb = plma_ctrlblk;
@@ -1253,63 +775,14 @@ void clean_client_info_node(PLMA_CLIENT_INFO 
*client_node)
        return;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*closes
-                                                                          *the
-                                                                          
*association
-                                                                          
*represented
-                                                                          *by
-                                                                          *the
-                                                                          *    
        plmHandle
-                                                                          
*parameter
-                                                                          
*between
-                                                                          *the
-                                                                          
*invoking
-                                                                          
*process
-                                                                          *and
-                                                                          *the
-                                                                          *    
        PLM
-                                                                          
*Service.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*plmHandle
-                                                                          *-
-                                                                          *A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*handle
-                                                                          
*designating
-                                                                          *this
-                                                                          *    
                        particular
-                                                                          
*initialization
-                                                                          *of
-                                                                          *the
-                                                                          *PLM
-                                                                          
*service,
-                                                                          *    
                        that
-                                                                          *is
-                                                                          *to
-                                                                          *be
-                                                                          
*returned
-                                                                          *by
-                                                                          *the
-                                                                          *PLM
-                                                                          
*service.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          
*values.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief    : This function closes the association represented by the plmHandle
+*            parameter between the invoking process and  PLM Service.
+* @param[in]: plmHandle - A pointer to the handle designating this particular
+*            initialization of the PLM service,that is to be returned by the
+*            PLM service.
+* @return   : Refer to SAI-AIS specification for various return values.
+***************************************************************************/
 SaAisErrorT saPlmFinalize(SaPlmHandleT plmHandle)
 {
        PLMA_CB *plma_cb = plma_ctrlblk;
@@ -1419,68 +892,15 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          *adds
-                                                                          *the
-                                                                          *new
-                                                                          
*entity
-                                                                          
*group
-                                                                          *info
-                                                                          
*created
-                                                                          *    
                to
-                                                                          *the
-                                                                          
*Entity
-                                                                          
*group
-                                                                          *info
-                                                                          *list
-                                                                          *of
-                                                                          
*client
-                                                                          
*info.
-                                                                          *
-                                                                          * 
@param[in,out]
-                                                                          
*listHead
-                                                                          *- A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          *head
-                                                                          *of
-                                                                          *the
-                                                                          *list
-                                                                          *of
-                                                                          *    
                            entity
-                                                                          
*group
-                                                                          
*info.
-                                                                          *    
                entityNew
-                                                                          *- A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          *new
-                                                                          
*entity
-                                                                          
*group
-                                                                          *info
-                                                                          *    
                            structure
-                                                                          
*which
-                                                                          *is
-                                                                          *to
-                                                                          *be
-                                                                          
*added
-                                                                          *to
-                                                                          *the
-                                                                          *the
-                                                                          *    
                            entity
-                                                                          
*group
-                                                                          *info
-                                                                          
*list.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Returns
-                                                                          
*nothing.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief        : This function adds the new entity group info created to the
+*                Entity group info list of client info.
+* @param[in,out]: listHead - A pointer to the head of the list of entity
+*                group info.
+*                entityNew - A pointer to the new entity group info structure
+*                which is to be added to the the entity group info list.
+* @return       : Returns nothing.
+***************************************************************************/
 void add_entity_grp_to_list(PLMA_ENTITY_GROUP_INFO_LIST **listHead,
                            PLMA_ENTITY_GROUP_INFO *entityNew)
 {
@@ -1515,72 +935,16 @@ void add_entity_grp_to_list(PLMA_ENTITY_GROUP_INFO_LIST 
**listHead,
        return;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*creates
-                                                                          *an
-                                                                          
*entity
-                                                                          
*group
-                                                                          *that
-                                                                          *may
-                                                                          *be
-                                                                          *used
-                                                                          *    
                later
-                                                                          *by
-                                                                          *the
-                                                                          
*invoking
-                                                                          
*process
-                                                                          *to
-                                                                          
*track
-                                                                          
*readiness
-                                                                          
*status
-                                                                          *    
                changes
-                                                                          *of
-                                                                          
*entities
-                                                                          *in
-                                                                          *the
-                                                                          
*group.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*plmHandle
-                                                                          *-
-                                                                          *The
-                                                                          
*handle
-                                                                          
*which
-                                                                          *was
-                                                                          
*obtained
-                                                                          *by a
-                                                                          *    
                              previous
-                                                                          
*invocation
-                                                                          *of
-                                                                          *the
-                                                                          *    
                              saPlmInitialize().
-                                                                          * 
@param[in,out]
-                                                                          
*groupHandle
-                                                                          *- A
-                                                                          
*pointer
-                                                                          *to a
-                                                                          
*memory
-                                                                          *area
-                                                                          *to
-                                                                          *hold
-                                                                          *the
-                                                                          *    
                              entity
-                                                                          
*group
-                                                                          
*handle.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          *    
                values.
-                                                                          
***************************************************************************/
+/************************************************************************
+* @brief        : This function creates an entity group that may be used later
+*                by the invoking process to track readiness status changes of
+*                 entities in the group.
+* @param[in]    : plmHandle - The handle which was obtained by a previous
+*                 invocation of the saPlmInitialize().
+* @param[in,out]: groupHandle - A pointer to a memory area to hold the entity
+*                group handle.
+* @return       : Refer to SAI-AIS specification for various return values.
+***************************************************************************/
 SaAisErrorT saPlmEntityGroupCreate(SaPlmHandleT plmHandle,
                                   SaPlmEntityGroupHandleT *groupHandle)
 {
@@ -1723,106 +1087,20 @@ end:
        /*return err code */
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*creates
-                                                                          *an
-                                                                          
*entity
-                                                                          
*group
-                                                                          *that
-                                                                          *may
-                                                                          *be
-                                                                          *used
-                                                                          *    
        later
-                                                                          *by
-                                                                          *the
-                                                                          
*invoking
-                                                                          
*process
-                                                                          *to
-                                                                          
*track
-                                                                          
*readiness
-                                                                          
*status
-                                                                          *    
        changes
-                                                                          *of
-                                                                          
*entities
-                                                                          *in
-                                                                          *the
-                                                                          
*group.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*entityGroupHandle
-                                                                          *-
-                                                                          *The
-                                                                          
*handle
-                                                                          *for
-                                                                          *an
-                                                                          
*entity
-                                                                          
*group
-                                                                          
*which
-                                                                          *    
                             was
-                                                                          
*obtained
-                                                                          *by a
-                                                                          
*previous
-                                                                          
*invocation
-                                                                          *    
                             of
-                                                                          *the
-                                                                          
*saPlmEntityGroupCreate()
-                                                                          
*function.
-                                                                          * 
@param[in]
-                                                                          
*entityNames
-                                                                          *-
-                                                                          
*Pointer
-                                                                          *to
-                                                                          *an
-                                                                          
*array
-                                                                          *of
-                                                                          
*entity
-                                                                          
*names.
-                                                                          * 
@param[in]
-                                                                          
*entityNamesNumber
-                                                                          *-
-                                                                          
*Number
-                                                                          *of
-                                                                          
*names
-                                                                          
*contained
-                                                                          *in
-                                                                          *the
-                                                                          
*array
-                                                                          *    
                             referred
-                                                                          *to
-                                                                          *by
-                                                                          
*entityNames.
-                                                                          * 
@param[in]
-                                                                          
*options
-                                                                          *-
-                                                                          
*Indicates
-                                                                          *how
-                                                                          
*entity
-                                                                          
*names
-                                                                          
*provided
-                                                                          *in
-                                                                          *the
-                                                                          *    
                             array
-                                                                          
*referred
-                                                                          *to
-                                                                          *by
-                                                                          
*entityNames
-                                                                          *must
-                                                                          *be
-                                                                          *    
                             interpreted.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          
*values.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief    : This function creates an entity group that may be used later by
+*            the invoking process to track readiness status changes of
+*            entities in the group.
+* @param[in]: entityGroupHandle - The handle for an entity group which was
+*            obtained by a previous invocation of the saPlmEntityGroupCreate()
+*            function.
+* @param[in]: entityNames - Pointer to an array of entity names.
+* @param[in]: entityNamesNumber - Number of names contained in the array
+*            referred to by entityNames.
+* @param[in]: options - Indicates how entity names provided in the array
+*            referred to by entityNames must be interpreted.
+* @return   : Refer to SAI-AIS specification for various return values.
+***************************************************************************/
 SaAisErrorT saPlmEntityGroupAdd(SaPlmEntityGroupHandleT entityGroupHandle,
                                const SaNameT *entityNames,
                                SaUint32T entityNamesNumber,
@@ -1974,92 +1252,19 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*removes
-                                                                          
*entities
-                                                                          *from
-                                                                          *the
-                                                                          
*entity
-                                                                          
*group
-                                                                          
*designated
-                                                                          *    
        by
-                                                                          
*entityGroupHandle.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*entityGroupHandle
-                                                                          *-
-                                                                          *The
-                                                                          
*handle
-                                                                          *for
-                                                                          *an
-                                                                          
*entity
-                                                                          
*group
-                                                                          
*which
-                                                                          *    
                             was
-                                                                          
*obtained
-                                                                          *by a
-                                                                          
*previous
-                                                                          
*invocation
-                                                                          *    
                             of
-                                                                          *the
-                                                                          
*saPlmEntityGroupCreate()
-                                                                          
*function.
-                                                                          * 
@param[in]
-                                                                          
*entityNames
-                                                                          *-
-                                                                          
*Pointer
-                                                                          *to
-                                                                          *an
-                                                                          
*array
-                                                                          *of
-                                                                          
*entity
-                                                                          
*names.
-                                                                          * 
@param[in]
-                                                                          
*entityNamesNumber
-                                                                          *-
-                                                                          
*Number
-                                                                          *of
-                                                                          
*names
-                                                                          
*contained
-                                                                          *in
-                                                                          *the
-                                                                          
*array
-                                                                          *    
                             referred
-                                                                          *to
-                                                                          *by
-                                                                          
*entityNames.
-                                                                          * 
@param[in]
-                                                                          
*options
-                                                                          *-
-                                                                          
*Indicates
-                                                                          *how
-                                                                          
*entity
-                                                                          
*names
-                                                                          
*provided
-                                                                          *in
-                                                                          *the
-                                                                          *    
                             array
-                                                                          
*referred
-                                                                          *to
-                                                                          *by
-                                                                          
*entityNames
-                                                                          *must
-                                                                          *be
-                                                                          *    
                             interpreted.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          
*values.
-                                                                          
***************************************************************************/
+/************************************************************************
+* @brief    : This function removes entities from the entity group designated 
by
+*            entityGroupHandle.
+* @param[in]: entityGroupHandle - The handle for an entity group which was
+*            obtained by a previous invocation of the saPlmEntityGroupCreate()
+*            function.
+* @param[in]: entityNames - Pointer to an array of entity names.
+* @param[in]: entityNamesNumber - Number of names contained in the array
+*            referred to by entityNames.
+* @param[in]: options - Indicates how entity names provided in the array
+*            referred to by entityNames must be interpreted.
+* @return   : Refer to SAI-AIS specification for various return values.
+***************************************************************************/
 SaAisErrorT saPlmEntityGroupRemove(SaPlmEntityGroupHandleT entityGroupHandle,
                                   const SaNameT *entityNames,
                                   SaUint32T entityNamesNumber)
@@ -2200,43 +1405,13 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*cleans
-                                                                          *the
-                                                                          
*group_info
-                                                                          
*stucture
-                                                                          
*before
-                                                                          *it
-                                                                          *is
-                                                                          *    
        deleted
-                                                                          *fron
-                                                                          *the
-                                                                          
*patricia
-                                                                          
*tree.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*group_info
-                                                                          *-
-                                                                          *A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*PLMA_ENTITY_GROUP_INFO
-                                                                          *    
                             structure
-                                                                          
*which
-                                                                          *has
-                                                                          *to
-                                                                          *be
-                                                                          
*cleaned
-                                                                          *up.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Returns
-                                                                          
*nothing.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief    : This function cleans the group_info stucture before it is deleted
+*            from the patricia tree.
+* @param[in]: group_info - A pointer to the PLMA_ENTITY_GROUP_INFO structure
+*            which has to be cleaned up.
+* @return   : Returns nothing.
+***************************************************************************/
 void clean_group_info_node(PLMA_ENTITY_GROUP_INFO *group_info)
 {
        PLMA_RDNS_TRK_MEM_LIST *rdns_trk_list = group_info->rdns_trk_mem_list;
@@ -2277,50 +1452,14 @@ void clean_group_info_node(PLMA_ENTITY_GROUP_INFO 
*group_info)
        return;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*deletes
-                                                                          *the
-                                                                          
*entity
-                                                                          
*group
-                                                                          
*designated
-                                                                          *by
-                                                                          *its
-                                                                          *    
        handle
-                                                                          
*entityGroupHandle.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*entityGroupHandle
-                                                                          *-
-                                                                          *The
-                                                                          
*handle
-                                                                          *for
-                                                                          *an
-                                                                          
*entity
-                                                                          
*group
-                                                                          
*which
-                                                                          *was
-                                                                          *    
                            obtained
-                                                                          *by a
-                                                                          
*previous
-                                                                          
*invocation
-                                                                          *of
-                                                                          *the
-                                                                          *    
                            saPlmEntityGroupCreate()
-                                                                          
*function.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          
*values.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief    : This function deletes the entity group designated by its handle
+*            entityGroupHandle.
+* @param[in]: entityGroupHandle - The handle for an entity group which was
+*            obtained by a previous invocation of the saPlmEntityGroupCreate()
+*            function.
+* @return   : Refer to SAI-AIS specification for various return values.
+***************************************************************************/
 SaAisErrorT saPlmEntityGroupDelete(SaPlmEntityGroupHandleT entityGroupHandle)
 {
 
@@ -2433,75 +1572,16 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          *adds
-                                                                          *the
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*entity
-                                                                          
*array,
-                                                                          *    
                which
-                                                                          *has
-                                                                          *to
-                                                                          *be
-                                                                          
*freed
-                                                                          *in
-                                                                          *the
-                                                                          *    
                saPlmReadinessNotificationFree
-                                                                          
*function,
-                                                                          *to
-                                                                          *the
-                                                                          
*list.
-                                                                          *
-                                                                          * 
@param[in,out]
-                                                                          
*entity_list
-                                                                          *- A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          *head
-                                                                          *of
-                                                                          *the
-                                                                          *list
-                                                                          *of
-                                                                          *    
                              entitiy
-                                                                          
*pointers
-                                                                          *to
-                                                                          
*which
-                                                                          *the
-                                                                          
*entity
-                                                                          *    
                              pointer
-                                                                          *has
-                                                                          *to
-                                                                          *be
-                                                                          
*added.
-                                                                          *    
                entity
-                                                                          *-
-                                                                          
*Pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*array
-                                                                          *of
-                                                                          
*entities
-                                                                          
*which
-                                                                          *    
                              has
-                                                                          *to
-                                                                          *be
-                                                                          
*freed
-                                                                          *by
-                                                                          
*using
-                                                                          *the
-                                                                          
*function
-                                                                          *    
                              saPlmReadinessNotificationFree.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Returns
-                                                                          
*nothing.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief        : This function adds the pointer to the entity array,which has
+*                to be freed in the saPlmReadinessNotificationFree function,to
+*                  the list.
+* @param[in,out]: entity_list - A pointer to the head of the list of entitiy
+*                pointers to which the entity pointer has to be added.
+*                entity - Pointer to the array of entities which has to be
+*                freed by using the function saPlmReadinessNotificationFree
+* @return       : Returns nothing.
+***************************************************************************/
 void add_entities_to_track_list(PLMA_RDNS_TRK_MEM_LIST **entity_list,
                                SaPlmReadinessTrackedEntityT *entity)
 {
@@ -2532,121 +1612,23 @@ void add_entities_to_track_list(PLMA_RDNS_TRK_MEM_LIST 
**entity_list,
        return;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          *can
-                                                                          *be
-                                                                          *used
-                                                                          *to
-                                                                          
*retrieve
-                                                                          *the
-                                                                          
*current
-                                                                          *    
                readiness
-                                                                          
*status
-                                                                          *of
-                                                                          *all
-                                                                          *PLM
-                                                                          
*entities
-                                                                          *that
-                                                                          *are
-                                                                          
*contained
-                                                                          *    
                in
-                                                                          *the
-                                                                          
*entity
-                                                                          
*group
-                                                                          
*referred
-                                                                          *to
-                                                                          *by
-                                                                          
*entityGroupHandle,
-                                                                          *    
                to
-                                                                          
*start
-                                                                          
*tracking
-                                                                          
*changes
-                                                                          *of
-                                                                          *the
-                                                                          
*readiness
-                                                                          
*status
-                                                                          *of
-                                                                          *    
                these
-                                                                          
*entities,
-                                                                          *or
-                                                                          *to
-                                                                          
*perform
-                                                                          *both
-                                                                          
*actions.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*entityGroupHandle
-                                                                          *-
-                                                                          *The
-                                                                          
*handle
-                                                                          *for
-                                                                          *an
-                                                                          
*entity
-                                                                          
*group
-                                                                          *    
                                     which
-                                                                          *was
-                                                                          
*obtained
-                                                                          *by a
-                                                                          
*previous
-                                                                          *    
                                     invocation
-                                                                          *of
-                                                                          *the
-                                                                          *    
                                     saPlmEntityGroupCreate()
-                                                                          
*function.
-                                                                          * 
@param[in]
-                                                                          
*trackCookie
-                                                                          *-
-                                                                          
*Value
-                                                                          
*provided
-                                                                          *by
-                                                                          *the
-                                                                          
*invoking
-                                                                          *    
                                     process,
-                                                                          *and
-                                                                          
*which
-                                                                          *will
-                                                                          *be
-                                                                          
*passed
-                                                                          *    
                                     as
-                                                                          *a
-                                                                          
*parameter
-                                                                          *to
-                                                                          *all
-                                                                          
*invocations
-                                                                          *    
                                     of
-                                                                          
*SaPlmReadinessTrackCallbackT
-                                                                          *    
                                     function
-                                                                          
*triggered
-                                                                          *by
-                                                                          *this
-                                                                          *    
                                     invocation
-                                                                          *of
-                                                                          *the
-                                                                          *    
                                     saPlmReadinessTrack()
-                                                                          
*function.
-                                                                          * 
@param[in,out]
-                                                                          
*trackedEntities
-                                                                          *- A
-                                                                          
*pointer
-                                                                          *to a
-                                                                          
*structure
-                                                                          *of
-                                                                          *type
-                                                                          *    
                                     SaPlmReadinessTrackedEntitiesT
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          *    
                values.
-                                                                          
***************************************************************************/
+/*************************************************************************
+* @brief        : This function can be used to retrieve the current readiness
+*                status of all PLM entities that are contained in the entity
+*                group referred to by entityGroupHandle,to start tracking
+*                 changes of the readiness status of these entities,or to
+*                perform both actions.
+* @param[in]    : entityGroupHandle - The handle for an entity group which was
+*                obtained by a previous invocation of the
+*                saPlmEntityGroupCreate() function.
+* @param[in]    : trackCookie - Value provided by the invoking process,and 
which
+*                will be passed as a parameter to all invocations of
+*                SaPlmReadinessTrackCallbackT function triggered by this
+*                invocation of the saPlmReadinessTrack() function.
+* @param[in,out]: trackedEntities - A pointer to a structure of type
+*                SaPlmReadinessTrackedEntitiesT
+* @return       : Refer to SAI-AIS specification for various return values.
+***************************************************************************/
 SaAisErrorT saPlmReadinessTrack(SaPlmEntityGroupHandleT entityGroupHandle,
                                SaUint8T trackFlags, SaUint64T trackCookie,
                                SaPlmReadinessTrackedEntitiesT *trackedEntities)
@@ -2870,104 +1852,20 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          *is
-                                                                          *used
-                                                                          *by a
-                                                                          
*process
-                                                                          *to
-                                                                          
*provide
-                                                                          *a
-                                                                          
*response
-                                                                          *to
-                                                                          *an
-                                                                          *    
        SaPlmReadinessTrackCallbackT
-                                                                          
*callback
-                                                                          
*previously
-                                                                          
*invoked
-                                                                          *with
-                                                                          *    
        a
-                                                                          *step
-                                                                          
*parameter
-                                                                          
*equal
-                                                                          *to
-                                                                          
*either
-                                                                          
*SA_PLM_CHANGE_VALIDATE
-                                                                          *or
-                                                                          *    
        SA_PLM_CHANGE_START.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*entityGrpHdl
-                                                                          *-
-                                                                          *The
-                                                                          
*handle
-                                                                          *for
-                                                                          *an
-                                                                          
*entity
-                                                                          
*group
-                                                                          
*which
-                                                                          *was
-                                                                          *    
                            obtained
-                                                                          *by a
-                                                                          
*previous
-                                                                          
*invocation
-                                                                          *of
-                                                                          *the
-                                                                          *    
                            saPlmEntityGroupCreate()
-                                                                          
*function.
-                                                                          * 
@param[in]
-                                                                          
*invocation
-                                                                          *-
-                                                                          *This
-                                                                          
*parameter
-                                                                          *was
-                                                                          
*provided
-                                                                          *to
-                                                                          *the
-                                                                          
*process
-                                                                          *    
                            by
-                                                                          *the
-                                                                          *PLM
-                                                                          
*Service
-                                                                          *in
-                                                                          *the
-                                                                          *    
                            SaPlmReadinessTrackCallbackT
-                                                                          
*callback.
-                                                                          * 
@param[in]
-                                                                          
*response
-                                                                          *-
-                                                                          *This
-                                                                          
*parameter
-                                                                          
*provides
-                                                                          *the
-                                                                          
*response
-                                                                          *    
                            expected
-                                                                          *by
-                                                                          *the
-                                                                          *PLM
-                                                                          
*Service
-                                                                          *to a
-                                                                          
*previous
-                                                                          *    
                            invocation
-                                                                          *of
-                                                                          *the
-                                                                          *    
                            SaPlmReadinessTrackCallbackT
-                                                                          
*track
-                                                                          
*callback.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          
*values.
-                                                                          
****************************************************************************/
+/*************************************************************************
+* @brief    : This function is used by a process to provide a response to an
+*            SaPlmReadinessTrackCallbackT callback previously invoked with
+*            a step parameter equal to either SA_PLM_CHANGE_VALIDATE or
+*             SA_PLM_CHANGE_START.
+* @param[in]: entityGrpHdl - The handle for an entity group which was obtained
+*            by a previous invocation of the saPlmEntityGroupCreate() function.
+* @param[in]: invocation - This parameter was provided to the process by the 
PLM
+*            Service in the SaPlmReadinessTrackCallbackT callback.
+* @param[in]: response - This parameter provides the response expected by the
+*            PLM Service to a previous invocation of the
+*            SaPlmReadinessTrackCallback track callback.
+* @return   : Refer to SAI-AIS specification for various return values.
+****************************************************************************/
 SaAisErrorT saPlmReadinessTrackResponse(SaPlmEntityGroupHandleT entityGrpHdl,
                                        SaInvocationT invocation,
                                        SaPlmReadinessTrackResponseT response)
@@ -3043,82 +1941,18 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*stops
-                                                                          *any
-                                                                          
*further
-                                                                          
*tracking
-                                                                          
*notifications
-                                                                          *    
        of
-                                                                          
*readiness
-                                                                          
*status
-                                                                          
*changes
-                                                                          *of
-                                                                          *the
-                                                                          
*group
-                                                                          *of
-                                                                          
*entities
-                                                                          
*designated
-                                                                          *    
        by
-                                                                          
*entityGroupHandle
-                                                                          *and
-                                                                          
*which
-                                                                          *were
-                                                                          
*requested
-                                                                          *by
-                                                                          
*specifying
-                                                                          *the
-                                                                          *    
        handle
-                                                                          
*entityGroupHandle
-                                                                          *when
-                                                                          
*invoking
-                                                                          *the
-                                                                          
*saPlmReadinessTrack()
-                                                                          *    
        function,
-                                                                          *and
-                                                                          
*which
-                                                                          *are
-                                                                          
*still
-                                                                          *in
-                                                                          
*effect.
-                                                                          *    
        Pending
-                                                                          
*callbacks
-                                                                          *are
-                                                                          
*removed.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*entityGroupHandle
-                                                                          *-
-                                                                          *The
-                                                                          
*handle
-                                                                          *for
-                                                                          *an
-                                                                          
*entity
-                                                                          
*group
-                                                                          
*which
-                                                                          *was
-                                                                          *    
                             obtained
-                                                                          *by a
-                                                                          
*previous
-                                                                          
*invocation
-                                                                          *of
-                                                                          *the
-                                                                          *    
                             saPlmEntityGroupCreate()
-                                                                          
*function.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          
*values.
-                                                                          
****************************************************************************/
+/*************************************************************************
+* @brief    : This function stops any further tracking notifications of
+*            readiness status changes of the group of entities designated by
+*            entityGroupHandle and which were requested by specifying the
+*            handle entityGroupHandle when invoking the saPlmReadinessTrack()
+*            function,and which are still in effect.Pending callbacks are
+*            removed.
+* @param[in]: entityGroupHandle - The handle for an entity group which was
+*            obtained by a previous invocation of the saPlmEntityGroupCreate()
+*            function.
+* @return   : Refer to SAI-AIS specification for various return values.
+****************************************************************************/
 SaAisErrorT saPlmReadinessTrackStop(SaPlmEntityGroupHandleT entityGroupHandle)
 {
 
@@ -3221,61 +2055,14 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*validates
-                                                                          
*memory
-                                                                          
*allocated
-                                                                          *for
-                                                                          
*entitis
-                                                                          *by
-                                                                          *PLM
-                                                                          *    
        in
-                                                                          *a
-                                                                          
*previous
-                                                                          *call
-                                                                          *to
-                                                                          *the
-                                                                          
*saPlmReadinessTrack()
-                                                                          
*function.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*entity_list
-                                                                          *-  A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          *head
-                                                                          *of
-                                                                          *list
-                                                                          *of
-                                                                          
*entity
-                                                                          *    
                           pointers
-                                                                          *to
-                                                                          *be
-                                                                          
*freed
-                                                                          *by
-                                                                          
*using
-                                                                          *    
                           saPlmReadinessNotificationFree()
-                                                                          
*function.
-                                                                          * 
@param[in]
-                                                                          
*entity_ptr
-                                                                          *-
-                                                                          
*Pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*array
-                                                                          *of
-                                                                          
*entities
-                                                                          *to
-                                                                          *be
-                                                                          
*freed.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
****************************************************************************/
+/***********************************************************************
+* @brief    : This function validates memory allocated for entitis by PLM in a
+*            previous call to the saPlmReadinessTrack() function.
+* @param[in]: entity_list -  A pointer to the head of list of entity pointers 
to
+*            be freed by using saPlmReadinessNotificationFree() function.
+* @param[in]: entity_ptr - Pointer to the array of entities to be freed.
+* @return   : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+****************************************************************************/
 uint32_t validate_entities_ptr(PLMA_RDNS_TRK_MEM_LIST **entity_list,
                               SaPlmReadinessTrackedEntityT *entity_ptr)
 {
@@ -3308,89 +2095,18 @@ uint32_t validate_entities_ptr(PLMA_RDNS_TRK_MEM_LIST 
**entity_list,
        return NCSCC_RC_FAILURE;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*frees
-                                                                          *the
-                                                                          
*memory
-                                                                          *to
-                                                                          
*which
-                                                                          
*entities
-                                                                          
*points
-                                                                          *and
-                                                                          *    
        which
-                                                                          *was
-                                                                          
*allocated
-                                                                          *by
-                                                                          *the
-                                                                          *PLM
-                                                                          
*Service
-                                                                          
*library
-                                                                          *in a
-                                                                          
*previous
-                                                                          *    
        call
-                                                                          *to
-                                                                          *the
-                                                                          
*saPlmReadinessTrack()
-                                                                          
*function.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*entityGroupHandle
-                                                                          *-
-                                                                          *The
-                                                                          
*handle
-                                                                          *for
-                                                                          *an
-                                                                          
*entity
-                                                                          
*group
-                                                                          
*which
-                                                                          *was
-                                                                          *    
                              obtained
-                                                                          *by a
-                                                                          
*previous
-                                                                          
*invocation
-                                                                          *of
-                                                                          *the
-                                                                          *    
                              saPlmEntityGroupCreate()
-                                                                          
*function.
-                                                                          * 
@param[in]
-                                                                          
*entities
-                                                                          *- A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*memory
-                                                                          
*array
-                                                                          *that
-                                                                          *was
-                                                                          *    
                              allocated
-                                                                          *by
-                                                                          *the
-                                                                          *PLM
-                                                                          
*Service
-                                                                          
*library
-                                                                          *in
-                                                                          *    
                              the
-                                                                          
*saPlmReadinessTrack()
-                                                                          
*function
-                                                                          *and
-                                                                          *    
                              is
-                                                                          *to
-                                                                          *be
-                                                                          
*deallocated.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          
*values.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief    : This function frees the memory to which entities points and which
+*            was allocated by the PLM Service library in a previous call to the
+*            saPlmReadinessTrack() function.
+* @param[in]: entityGroupHandle - The handle for an entity group which was
+*            obtained by a previous invocation of the saPlmEntityGroupCreate()
+*            function.
+* @param[in]: entities - A pointer to the memory array that was allocated by 
the
+*            PLM Service library in the saPlmReadinessTrack() function and is
+*            to be deallocated.
+* @return   : Refer to SAI-AIS specification for various return values.
+***************************************************************************/
 SaAisErrorT
 saPlmReadinessNotificationFree(SaPlmEntityGroupHandleT entityGroupHandle,
                               SaPlmReadinessTrackedEntityT *entities)
@@ -3447,85 +2163,18 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          *is
-                                                                          *used
-                                                                          *by
-                                                                          
*processes
-                                                                          *to
-                                                                          
*report
-                                                                          *that
-                                                                          *the
-                                                                          *    
                state
-                                                                          *of
-                                                                          
*health
-                                                                          *of
-                                                                          *an
-                                                                          
*entity
-                                                                          *has
-                                                                          
*changed.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*plmHandle
-                                                                          *-
-                                                                          *The
-                                                                          
*handle
-                                                                          
*which
-                                                                          *was
-                                                                          
*obtained
-                                                                          *by a
-                                                                          *    
                                  previous
-                                                                          
*invocation
-                                                                          *of
-                                                                          *the
-                                                                          *    
                                  saPlmInitialize()
-                                                                          
*function.
-                                                                          * 
@param[in]
-                                                                          
*impactedEntity
-                                                                          *-
-                                                                          
*Pointer
-                                                                          *to
-                                                                          *the
-                                                                          *name
-                                                                          *of
-                                                                          *the
-                                                                          
*entity
-                                                                          *    
                                  whose
-                                                                          
*readiness
-                                                                          
*status
-                                                                          
*should
-                                                                          *be
-                                                                          *    
                                  updated.
-                                                                          * 
@param[in]
-                                                                          
*impact
-                                                                          *-
-                                                                          
*Impact
-                                                                          
*being
-                                                                          
*reported.
-                                                                          * 
@param[in,out]
-                                                                          
*correlationIds
-                                                                          *-
-                                                                          
*Pointer
-                                                                          *to a
-                                                                          
*structure
-                                                                          *that
-                                                                          
*contains
-                                                                          *    
                                  correlation
-                                                                          
*identifiers.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Refer
-                                                                          *to
-                                                                          
*SAI-AIS
-                                                                          
*specification
-                                                                          *for
-                                                                          
*various
-                                                                          
*return
-                                                                          *    
                values.
-                                                                          
****************************************************************************/
+/*************************************************************************
+* @brief        : This function is used by processes to report that the state 
of
+*                health of an entity has changed.
+* @param[in]    : plmHandle - The handle which was obtained by a previous
+*                invocation of the saPlmInitialize() function.
+* @param[in]    : impactedEntity - Pointer to the name of the entity whose
+*                readiness status should be updated.
+* @param[in]    : impact - Impact being reported.
+* @param[in,out]: correlationIds - Pointer to a structure that contains
+*                correlation identifiers.
+* @return       : Refer to SAI-AIS specification for various return values.
+****************************************************************************/
 SaAisErrorT saPlmEntityReadinessImpact(SaPlmHandleT plmHandle,
                                       const SaNameT *impactedEntity,
                                       SaPlmReadinessImpactT impact,
diff --git a/src/plm/agent/plma_comm.c b/src/plm/agent/plma_comm.c
index 4824a44..119d496 100644
--- a/src/plm/agent/plma_comm.c
+++ b/src/plm/agent/plma_comm.c
@@ -1,33 +1,12 @@
 #include "plma.h"
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          *is
-                                                                          *used
-                                                                          *to
-                                                                          
*clean
-                                                                          *up
-                                                                          *the
-                                                                          
*mailbox.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          *arg
-                                                                          *-
-                                                                          * 
@param[in]
-                                                                          *msg
-                                                                          *-
-                                                                          *
-                                                                          * 
@return
-                                                                          *0 -
-                                                                          *If
-                                                                          
*failure
-                                                                          * 
@return
-                                                                          *1 -
-                                                                          *If
-                                                                          
*success
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief    : This routine is used to clean up the mailbox.
+* @param[in]: arg
+* @param[in]: msg
+* @return   : 0 - If failure
+* @return   : 1 - If success
+***************************************************************************/
 static bool plma_client_cleanup_mbx(NCSCONTEXT arg, NCSCONTEXT msg)
 {
        PLMS_EVT *cbk_msg, *pnext;
@@ -42,32 +21,11 @@ static bool plma_client_cleanup_mbx(NCSCONTEXT arg, 
NCSCONTEXT msg)
        return true;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          *is
-                                                                          *used
-                                                                          *to
-                                                                          
*initialize
-                                                                          *the
-                                                                          
*queue
-                                                                          *for
-                                                                          *the
-                                                                          
*callbacks.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*client_info
-                                                                          *-
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*client
-                                                                          
*info.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/*************************************************************************
+* @brief    : This routine is used to initialize the queue for the callbacks.
+* @param[in]: client_info - pointer to the client info.
+* @return   : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plma_callback_ipc_init(PLMA_CLIENT_INFO *client_info)
 {
        uint32_t rc = NCSCC_RC_SUCCESS;
diff --git a/src/plm/agent/plma_init.c b/src/plm/agent/plma_init.c
index 050718b..1930680 100644
--- a/src/plm/agent/plma_init.c
+++ b/src/plm/agent/plma_init.c
@@ -12,30 +12,15 @@
  * licensing terms.
  *
  * Author(s): Emerson Network Power
- *
+ *            High Availability Solutions Pvt. Ltd.
  */
 
-/*************************************************************************/ /**
-                                                                            * 
@file
-                                                                            
*plma_init.c
-                                                                            * 
@brief
-                                                                            
*This
-                                                                            
*file
-                                                                            
*contains
-                                                                            
*the
-                                                                            
*initialization
-                                                                            
*and
-                                                                            
*destroy
-                                                                            
*routines
-                                                                            
*for
-                                                                            *  
        PLMA
-                                                                            
*library.
-                                                                            *
-                                                                            * 
@author
-                                                                            
*Emerson
-                                                                            
*Network
-                                                                            
*Power
-                                                                            
*****************************************************************************/
+/*************************************************************************
+* @file  : plma_init.c
+* @brief : This file contains the initialization and destroy routines for
+*         PLMA library.
+* @author: Emerson Network Power
+*****************************************************************************/
 
 #include "base/ncssysf_def.h"
 
@@ -52,21 +37,10 @@ void plma_sync_with_plms(void);
 /* mutex for synchronising agent startup and shutdown */
 static pthread_mutex_t s_agent_startup_mutex = PTHREAD_MUTEX_INITIALIZER;
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          *is
-                                                                          *used
-                                                                          *to
-                                                                          
*initialize
-                                                                          *the
-                                                                          
*client
-                                                                          
*tree.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief : This routine is used to initialize the client tree.
+* @return: NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plma_client_tree_init()
 {
        NCS_PATRICIA_PARAMS param;
@@ -85,21 +59,10 @@ uint32_t plma_client_tree_init()
        return NCSCC_RC_SUCCESS;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          *is
-                                                                          *used
-                                                                          *to
-                                                                          
*initialize
-                                                                          *the
-                                                                          
*group
-                                                                          
*tree.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief : This routine is used to initialize the group tree.
+* @return: NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plma_group_tree_init()
 {
        NCS_PATRICIA_PARAMS param;
@@ -118,21 +81,10 @@ uint32_t plma_group_tree_init()
        return NCSCC_RC_SUCCESS;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          *is
-                                                                          *used
-                                                                          *to
-                                                                          
*destroy
-                                                                          *the
-                                                                          
*client
-                                                                          
*tree.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief : This routine is used to destroy the client tree.
+* @return: NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plma_client_tree_destroy()
 {
        /** cleanup the client tree */
@@ -169,22 +121,10 @@ uint32_t plma_client_tree_destroy()
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          *is
-                                                                          *used
-                                                                          *to
-                                                                          
*destroy
-                                                                          *the
-                                                                          
*group
-                                                                          *info
-                                                                          
*tree.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief : This routine is used to destroy the group info tree.
+* @return: NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plma_group_tree_destroy()
 {
        /* cleanup the client tree */
@@ -219,44 +159,13 @@ uint32_t plma_group_tree_destroy()
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          
*creates
-                                                                          *and
-                                                                          
*initializes
-                                                                          *the
-                                                                          *PLMA
-                                                                          
*Control
-                                                                          
*block.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*create_info
-                                                                          *- A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*structure
-                                                                          *that
-                                                                          *has
-                                                                          
*creation
-                                                                          *    
                      parameters,
-                                                                          *if
-                                                                          *any,
-                                                                          *are
-                                                                          
*provided
-                                                                          *to
-                                                                          
*libraries
-                                                                          *    
                      in
-                                                                          *a
-                                                                          
*command-line
-                                                                          
*arguments
-                                                                          
*style.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief    : This routine creates and initializes the PLMA Control block.
+* @param[in]: create_info - A pointer to the structure that has creation
+*            parameters, if any, are provided to libraries in a command-line
+*            arguments style.
+* @return   : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plma_create(NCS_LIB_CREATE *create_info)
 {
 
@@ -335,28 +244,11 @@ end:
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          
*destroys
-                                                                          *the
-                                                                          *PLMA
-                                                                          
*Control
-                                                                          
*block.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*destroy_info
-                                                                          *- A
-                                                                          
*pointer
-                                                                          *to
-                                                                          *the
-                                                                          
*NCS_LIB_DESTROY
-                                                                          
*structure.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief    : This routine destroys the PLMA Control block.
+* @param[in]: destroy_info - A pointer to the NCS_LIB_DESTROY structure.
+* @return   : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plma_destroy(NCS_LIB_DESTROY *destroy_info)
 {
        PLMA_CB *plma_cb = plma_ctrlblk;
@@ -383,38 +275,12 @@ uint32_t plma_destroy(NCS_LIB_DESTROY *destroy_info)
        return NCSCC_RC_SUCCESS;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          *is
-                                                                          
*exported
-                                                                          *to
-                                                                          *the
-                                                                          
*external
-                                                                          
*entities
-                                                                          *& is
-                                                                          *used
-                                                                          *    
        to
-                                                                          
*create
-                                                                          *&
-                                                                          
*destroy
-                                                                          *the
-                                                                          *PLMA
-                                                                          
*library.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*req_info
-                                                                          *-
-                                                                          *ptr
-                                                                          *to
-                                                                          *the
-                                                                          
*request
-                                                                          *info
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief    : This routine is exported to the external entities & is used to
+*            create & destroy the PLMA library.
+* @param[in]: req_info - ptr to the request info
+* @return   : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plma_lib_req(NCS_LIB_REQ_INFO *req_info)
 {
        uint32_t rc = NCSCC_RC_SUCCESS;
@@ -439,39 +305,12 @@ uint32_t plma_lib_req(NCS_LIB_REQ_INFO *req_info)
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          
*creates
-                                                                          *a
-                                                                          
*PLMSv
-                                                                          
*agent
-                                                                          
*infrastructure
-                                                                          *to
-                                                                          
*interface
-                                                                          *    
        with
-                                                                          
*PLMSv
-                                                                          
*service.
-                                                                          *Once
-                                                                          *the
-                                                                          
*infrastructure
-                                                                          *is
-                                                                          
*created
-                                                                          *from
-                                                                          *    
        then
-                                                                          *on
-                                                                          
*use_count
-                                                                          *is
-                                                                          
*incremented
-                                                                          *for
-                                                                          
*every
-                                                                          
*startup
-                                                                          
*request.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief : This routine creates a PLMSv agent infrastructure to interface with
+*         PLMSv service.Once the infrastructure is created from then on
+*         use_count is incremented for every startup request.
+* @return: NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t ncs_plma_startup()
 {
        NCS_LIB_REQ_INFO lib_create;
@@ -501,36 +340,12 @@ uint32_t ncs_plma_startup()
        return NCSCC_RC_SUCCESS;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          
*destroys
-                                                                          *the
-                                                                          
*PLMSv
-                                                                          
*agent
-                                                                          
*infrastructure
-                                                                          
*created
-                                                                          *    
        to
-                                                                          
*nterface
-                                                                          *with
-                                                                          
*PLMSv
-                                                                          
*service.
-                                                                          *If
-                                                                          *the
-                                                                          
*registered
-                                                                          
*users
-                                                                          *are
-                                                                          *>1,
-                                                                          *    
        it
-                                                                          *just
-                                                                          
*decrements
-                                                                          *the
-                                                                          
*use_count.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief : This routine destroys the PLMSv agent infrastructure created to
+*         interface with PLMSv service.If the registered users are >1,it just
+*         decrements the use_count.
+* @return: NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t ncs_plma_shutdown()
 {
        NCS_LIB_REQ_INFO lib_destroy;
diff --git a/src/plm/agent/plma_mds.c b/src/plm/agent/plma_mds.c
index 9e9b6de..0f60812 100644
--- a/src/plm/agent/plma_mds.c
+++ b/src/plm/agent/plma_mds.c
@@ -12,30 +12,14 @@
  * licensing terms.
  *
  * Author(s): Emerson
- *
+ *            High Availability Solutions Pvt. Ltd.
  */
 
-/*************************************************************************/ /**
-                                                                            * 
@file
-                                                                            
*plma_mds.c
-                                                                            * 
@brief
-                                                                            
*This
-                                                                            
*file
-                                                                            
*contains
-                                                                            
*routines
-                                                                            
*used
-                                                                            *by
-                                                                            
*PLMA
-                                                                            
*library
-                                                                            
*for
-                                                                            
*MDS
-                                                                            *  
        Interface.
-                                                                            *
-                                                                            * 
@author
-                                                                            
*Emerson
-                                                                            
*Network
-                                                                            
*Power
-                                                                            
*****************************************************************************/
+/*************************************************************************
+* @file  : plma_mds.c
+* @brief : This file contains routines used by PLMA library for MDS Interface.
+* @author: Emerson Network Power
+*****************************************************************************/
 
 #include "plma.h"
 #include "base/osaf_poll.h"
@@ -47,19 +31,10 @@ uint32_t plma_mds_callback(struct ncsmds_callback_info 
*info);
 static uint32_t plma_mds_rcv(MDS_CALLBACK_RECEIVE_INFO *rcv_info);
 static uint32_t plma_mds_svc_evt(MDS_CALLBACK_SVC_EVENT_INFO *svc_evt);
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          *gets
-                                                                          *MDS
-                                                                          
*handle
-                                                                          *for
-                                                                          
*PLMA.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief : This routine gets MDS handle for PLMA.
+* @return: NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plma_mds_get_handle()
 {
        NCSADA_INFO arg;
@@ -86,19 +61,10 @@ uint32_t plma_mds_get_handle()
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*routine
-                                                                          
*registers
-                                                                          *the
-                                                                          *PLMA
-                                                                          *with
-                                                                          *MDS.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief : This routine registers the PLMA with MDS.
+* @return: NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 uint32_t plma_mds_register()
 {
        uint32_t rc = NCSCC_RC_SUCCESS;
@@ -221,28 +187,11 @@ uint32_t plma_mds_callback(struct ncsmds_callback_info 
*info)
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *MDS
-                                                                          *will
-                                                                          *call
-                                                                          *this
-                                                                          
*function
-                                                                          *on
-                                                                          
*receiving
-                                                                          *PLMA
-                                                                          
*messages.
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*rcv_info
-                                                                          *-
-                                                                          *MDS
-                                                                          
*Receive
-                                                                          
*information.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief    : MDS will call this function on receiving PLMA messages.
+* @param[in]: rcv_info - MDS Receive information.
+* @return   : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 static uint32_t plma_mds_rcv(MDS_CALLBACK_RECEIVE_INFO *rcv_info)
 {
        uint32_t rc = NCSCC_RC_SUCCESS;
@@ -294,32 +243,11 @@ static uint32_t plma_mds_rcv(MDS_CALLBACK_RECEIVE_INFO 
*rcv_info)
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *PLMA
-                                                                          *is
-                                                                          
*informed
-                                                                          *when
-                                                                          *MDS
-                                                                          
*events
-                                                                          
*occur
-                                                                          *that
-                                                                          *he
-                                                                          *has
-                                                                          *    
        subscribed
-                                                                          *to
-                                                                          *
-                                                                          * 
@param[in]
-                                                                          
*svc_evt
-                                                                          *-
-                                                                          *MDS
-                                                                          *Svc
-                                                                          *evt
-                                                                          
*info.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief    : PLMA is informed when MDS events occur that he has subscribed to.
+* @param[in]: svc_evt - MDS Svc evt info.
+* @return   : NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 static uint32_t plma_mds_svc_evt(MDS_CALLBACK_SVC_EVENT_INFO *svc_evt)
 {
        uint32_t rc = NCSCC_RC_SUCCESS;
@@ -362,20 +290,10 @@ static uint32_t 
plma_mds_svc_evt(MDS_CALLBACK_SVC_EVENT_INFO *svc_evt)
        return rc;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          
*un-registers
-                                                                          *the
-                                                                          *PLMA
-                                                                          
*Service
-                                                                          *with
-                                                                          *MDS.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief : This function un-registers the PLMA Service with MDS.
+* @return: NCSCC_RC_SUCCESS/NCSCC_RC_FAILURE.
+***************************************************************************/
 void plma_mds_unregister()
 {
        NCSMDS_INFO arg;
@@ -403,27 +321,11 @@ done:
        return;
 }
 
-/***********************************************************************/ /**
-                                                                          * 
@brief
-                                                                          *This
-                                                                          
*function
-                                                                          *is
-                                                                          *for
-                                                                          *PLMA
-                                                                          *to
-                                                                          *sync
-                                                                          *with
-                                                                          *PLMS
-                                                                          *when
-                                                                          *it
-                                                                          *gets
-                                                                          *    
        MDS
-                                                                          
*callback.
-                                                                          *
-                                                                          * 
@return
-                                                                          
*Returns
-                                                                          
*nothing.
-                                                                          
***************************************************************************/
+/***********************************************************************
+* @brief : This function is for PLMA to sync with PLMS when it gets
+*         MDS callback.
+* @return: Returns nothing.
+***************************************************************************/
 void plma_sync_with_plms()
 {
        PLMA_CB *cb = plma_ctrlblk;
-- 
2.7.4



_______________________________________________
Opensaf-devel mailing list
Opensaf-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/opensaf-devel

Reply via email to