From 460d2d96c2a485b95ef58f1f579ee3ddf4fc37f3 Mon Sep 17 00:00:00 2001 From: Dmitriy Simushev Date: Fri, 3 Aug 2012 11:23:09 +0000 Subject: [PATCH] Added some documentation to the MibewAPI class --- src/messenger/webim/libs/mibew_api.php | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/messenger/webim/libs/mibew_api.php b/src/messenger/webim/libs/mibew_api.php index e8dd8f3c..53d762e6 100644 --- a/src/messenger/webim/libs/mibew_api.php +++ b/src/messenger/webim/libs/mibew_api.php @@ -40,6 +40,13 @@ Class MibewAPI { */ protected $interaction = NULL; + /** + * Returns MibewAPI object + * + * @param string $interaction_type A name of the interaction type + * @return MibeAPI object + * @throws MibewAPIException + */ public static function getAPI($interaction_type) { $class_name = "MibewAPI". ucfirst($interaction_type) . "Interaction"; if (! class_exists($class_name)) { @@ -54,6 +61,11 @@ Class MibewAPI { return self::$interactions[$interaction_type]; } + /** + * Class constructor + * + * @param MibewAPIInteraction $interaction_type Interaction type object + */ protected function __construct(MibewAPIInteraction $interaction_type) { $this->interaction = $interaction_type; }