From be5393fed503483d13690aeca881574b53c222e8 Mon Sep 17 00:00:00 2001
From: Peter Westwood <westi@git.wordpress.org>
Date: Thu, 20 Dec 2007 22:28:54 +0000
Subject: [PATCH] Add file level phpdoc to external libraries we use. Fixes
 #5443 props darkdragon.

git-svn-id: https://develop.svn.wordpress.org/trunk@6440 602fd350-edb4-49c9-b593-d223f7449a82
---
 wp-includes/atomlib.php      | 53 ++++++++++++++++++++++++++++++++----
 wp-includes/class-IXR.php    | 22 +++++++++------
 wp-includes/class-phpass.php |  8 ++++++
 wp-includes/class-pop3.php   | 33 +++++++++++-----------
 wp-includes/class-snoopy.php | 10 ++++++-
 5 files changed, 95 insertions(+), 31 deletions(-)

diff --git a/wp-includes/atomlib.php b/wp-includes/atomlib.php
index a5189084f4..9c2335c661 100644
--- a/wp-includes/atomlib.php
+++ b/wp-includes/atomlib.php
@@ -1,26 +1,67 @@
 <?php
 /*
- * atomlib.php - Atom Syndication Format PHP Library
+ * Atom Syndication Format PHP Library
  *
- * Project: http://code.google.com/p/phpatomlib/
- *
- * Author: Elias Torres <elias@torrez.us>
- * Version: 0.4
+ * @package AtomLib
+ * @link http://code.google.com/p/phpatomlib/
  *
+ * @author: Elias Torres <elias@torrez.us>
+ * @version: 0.4
+ * @since 2.3
  */
 
+/**
+ * Structure that store common Atom Feed Properties
+ *
+ * @package AtomLib
+ */
 class AtomFeed {
+	/**
+	 * Stores Links
+	 * @var array
+	 * @access public
+	 */
     var $links = array();
+    /**
+     * Stores Categories
+     * @var array
+     * @access public
+     */
     var $categories = array();
-
+	/**
+	 * Stores Entries
+	 *
+	 * @var array
+	 * @access public
+	 */
     var $entries = array();
 }
 
+/**
+ * Structure that store Atom Entry Properties
+ *
+ * @package AtomLib
+ */
 class AtomEntry {
+	/**
+	 * Stores Links
+	 * @var array
+	 * @access public
+	 */
     var $links = array();
+    /**
+     * Stores Categories
+     * @var array
+	 * @access public
+     */
     var $categories = array();
 }
 
+/**
+ * AtomLib Atom Parser API
+ *
+ * @package AtomLib
+ */
 class AtomParser {
 
     var $NS = 'http://www.w3.org/2005/Atom';
diff --git a/wp-includes/class-IXR.php b/wp-includes/class-IXR.php
index 2b23a1d135..e325ae5582 100644
--- a/wp-includes/class-IXR.php
+++ b/wp-includes/class-IXR.php
@@ -1,11 +1,17 @@
 <?php
-/*
-   IXR - The Inutio XML-RPC Library - (c) Incutio Ltd 2002-2005
-   Version 1.7 (beta) - Simon Willison, 23rd May 2005
-   Site:   http://scripts.incutio.com/xmlrpc/
-   Manual: http://scripts.incutio.com/xmlrpc/manual.php
-   Made available under the BSD License: http://www.opensource.org/licenses/bsd-license.php
-*/
+/**
+ * IXR - The Inutio XML-RPC Library
+ *
+ * @package IXR
+ * @since 1.5
+ *
+ * @copyright Incutio Ltd 2002-2005
+ * @version 1.7 (beta) 23rd May 2005
+ * @author Simon Willison
+ * @link http://scripts.incutio.com/xmlrpc/ Site
+ * @link http://scripts.incutio.com/xmlrpc/manual.php Manual
+ * @license BSD License http://www.opensource.org/licenses/bsd-license.php
+ */
 
 class IXR_Value {
     var $data;
@@ -812,4 +818,4 @@ class IXR_ClientMulticall extends IXR_Client {
     }
 }
 
-?>
\ No newline at end of file
+?>
diff --git a/wp-includes/class-phpass.php b/wp-includes/class-phpass.php
index 550a01b704..71208b806c 100644
--- a/wp-includes/class-phpass.php
+++ b/wp-includes/class-phpass.php
@@ -1,4 +1,12 @@
 <?php
+/**
+ * Portable PHP password hashing framework.
+ * @package phpass
+ * @since 2.4
+ * @version 0.1
+ * @link http://www.openwall.com/phpass/
+ */
+
 #
 # Portable PHP password hashing framework.
 #
diff --git a/wp-includes/class-pop3.php b/wp-includes/class-pop3.php
index 0822aa7daa..610f678d8f 100644
--- a/wp-includes/class-pop3.php
+++ b/wp-includes/class-pop3.php
@@ -1,20 +1,21 @@
 <?php
-
-   /**
-    * mail_fetch/setup.php
-    *
-    * Copyright (c) 1999-2006 The SquirrelMail Project Team
-    *
-    * Copyright (c) 1999 CDI (cdi@thewebmasters.net) All Rights Reserved
-    * Modified by Philippe Mingo 2001 mingo@rotedic.com
-    * An RFC 1939 compliant wrapper class for the POP3 protocol.
-    *
-    * Licensed under the GNU GPL. For full terms see the file COPYING.
-    *
-    * pop3 class
-    *
-    * $Id$
-    */
+/**
+ * mail_fetch/setup.php
+ *
+ * @package SquirrelMail
+ *
+ * @copyright (c) 1999-2006 The SquirrelMail Project Team
+ *
+ * @copyright (c) 1999 CDI (cdi@thewebmasters.net) All Rights Reserved
+ * Modified by Philippe Mingo 2001 mingo@rotedic.com
+ * An RFC 1939 compliant wrapper class for the POP3 protocol.
+ *
+ * Licensed under the GNU GPL. For full terms see the file COPYING.
+ *
+ * pop3 class
+ *
+ * $Id$
+ */
 
 class POP3 {
     var $ERROR      = '';       //  Error string.
diff --git a/wp-includes/class-snoopy.php b/wp-includes/class-snoopy.php
index 9e60206d62..12f0e97054 100644
--- a/wp-includes/class-snoopy.php
+++ b/wp-includes/class-snoopy.php
@@ -1,5 +1,13 @@
 <?php
-
+/**
+ * Snoopy - the PHP net client
+ * @author Monte Ohrt <monte@ispi.net>
+ * @copyright 1999-2000 ispi, all rights reserved
+ * @version 1.01
+ * @license GNU Lesser GPL
+ * @link http://snoopy.sourceforge.net/
+ * @package Snoopy
+ */
 /*************************************************
 
 Snoopy - the PHP net client