TICS Coding Standard Viewer 
TIOBE Software Quality Framework
Print-friendly version
©TIOBE Software www.tiobe.com
 
ASML C Coding Standard
Search

Rule:  5.1.1.2.bChecked automatically with code checker

Synopsis:Each non-trivial function shall be accompanied by a doxygen style function header.
Language:C
Severity Level:6
Category:Conceptual Models


Description:

Justification

Enough information should be provided by the function header to help the reader to use the function without the necessity of reading the implementation of the function and to help the reviewer to verify whether the function has correctly been coded.

Example

/*----------------------------------------------------------------------------*/
int get_maintenance_status(
    FIRST_MAINTENANCE_STRUCT *first_maintenance,
    MAINTENACE_STATUST_STRUCT *maintenance_status,
    const SHARED_DATE_STRUCT *sh_data)
/**
 * \brief Returns the time to the next maintenance action
 * \param[in] sh_data  The shared data structure
 * \param[out] first_maintenance  Indication when first maintenance is required
 * \param[out] maintenance_status  Indication time to go before maintenance
 * \return error status  OK, SYS_ERR
 * \retval  {description}
 * \pre None
 * \post first_maintenance
 *       maintenance_status 
 *       - Initialised with zeroes
 * \note The precondition implies that this is a maintenance object.
 */
{
   /* Function definition */
}