added comments for phpDoc - rss module

git-svn-id: http://xe-core.googlecode.com/svn/branches/1.5.0@10757 201d5d3c-b55e-5fd7-737f-ddc643e51545
This commit is contained in:
chschy 2012-05-31 06:53:06 +00:00
parent 3c609ae06a
commit 32284aa5a7
6 changed files with 90 additions and 48 deletions

View file

@ -1,24 +1,27 @@
<?php
/**
* @class rssView
* @author NHN (developers@xpressengine.com)
* @brief The view class of the rss module
*
* Feed the document output
*
* The view class of the rss module
*
* @author NHN (developers@xpressengine.com)
**/
class rssView extends rss {
/**
* @brief Initialization
* Initialization
*
* @return void
**/
function init() {
}
/**
* @brief Feed output
* Feed output.
* When trying to directly print out the RSS, the results variable can be directly specified through $oRssView->rss($document_list)
*
* @param Object $document_list Document list
* @param string $rss_title Rss title
* @param string $add_description Add description
**/
function rss($document_list = null, $rss_title = null, $add_description = null) {
$oDocumentModel = &getModel('document');
@ -181,7 +184,9 @@
$this->setTemplateFile('display');
}
/**
* @brief ATOM output
* ATOM output
*
* @return Object
**/
function atom() {
Context::set('format', 'atom');
@ -189,7 +194,9 @@
}
/**
* @brief Error output
* Error output
*
* @return Object
**/
function dispError() {
// Prepare the output message
@ -197,8 +204,11 @@
}
/**
* @brief Additional configurations for a service module
* Additional configurations for a service module
* Receive the form for the form used by rss
*
* @param string $obj Will be inserted content in template
* @return Object
**/
function triggerDispRssAdditionSetup(&$obj) {
$current_module_srl = Context::get('module_srl');