Feature #77: All files need function headers and also file headers - pfSense - pfSense bugtracker

Actions

Copy link

Feature #77

closed

All files need function headers and also file headers

Added by Scott Ullrich over 15 years ago. Updated almost 9 years ago.

Status:

Closed

Priority:

Very Low

Assignee:

Category:

Target version:

Start date:

09/04/2009

Due date:

% Done:

Estimated time:

Plus Target Version:

Release Notes:

Description

Need file headers such as this:

/****h* pfSense/notices * NAME * notices.inc - pfSense notice utilities * DESCRIPTION * This include contains the pfSense notice facilities. * HISTORY * $Id$ *
/

Need function header on each function such as this:
/****f* notices/file_notice * NAME * file_notice * INPUTS * $id, $notice, $category, $url, $priority * RESULT * Files a notice and kicks off the various alerts, smtp, growl, system log, LED's, etc.
**/

We can then begin creating api documentation again after these fixes.