Add docs for function

[squirrelmail.git] / src / view_header.php

diff --git a/src/view_header.php b/src/view_header.php
index 8819f21b60e2051a1467038bd48ed3c5307a1dcc..2d215608ebe2d7b97ea54951b989bbcdc39cd049 100644 (file)
--- a/src/view_header.php
+++ b/src/view_header.php
@@ -5,7 +5,7 @@
  *
  * This is the code to view the message header.
  *
- * @copyright 1999-2015 The SquirrelMail Project Team
+ * @copyright 1999-2017 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -23,7 +23,21 @@ require('../include/init.php');
 require_once(SM_PATH . 'functions/imap.php');
 require_once(SM_PATH . 'functions/url_parser.php');
 
-function parse_viewheader($imapConnection,$id, $passed_ent_id) {
+/**
+  * Extract message headers
+  *
+  * @param resource $imapConnection
+  * @param string $id Message ID
+  * @param string $passed_ent_id Nested/attached/embedded message ID (if any)
+  *
+  * @return array List of all message headers, where each
+  *               element is a sub-array that contains two
+  *               elements: header name and header value
+  *               (in that order) where the header value is
+  *               HTML-formatted, ready for display in browser
+  *
+  */
+function parse_viewheader($imapConnection, $id, $passed_ent_id) {
 
     $header_output = array();
     $second = array();