VirtueMart

<?php

/**

*

* Description

*

* @package VirtueMart

* @subpackage

* @author

* @link http://www.virtuemart.net

* @copyright Copyright (c) 2004 - 2010 VirtueMart Team. All rights reserved.

* @license http://www.gnu.org/copyleft/gpl.html GNU/GPL, see LICENSE.php

* VirtueMart is free software. This version may have been modified pursuant

* to the GNU General Public License, and as distributed it includes or

* is derivative of works licensed under the GNU General Public License or

* other free or open source software licenses.

* @version $Id: $

*/

// Check to ensure this file is included in Joomla!

defined('_JEXEC') or die('Restricted access');

// Load the model framework

jimport('joomla.application.component.model');

/**

* Class Description

*

* @package VirtueMart

* @author

*/

class VirtueMartModel<name> extends JModel {

/**

* Method Description

*

* @access (define if the method is public or private here)

* @author

*/

function __construct() {

parent::__construct();

}

You may use the @var tag to document the data type of class variables.

Example

/** @var integer Primary key */

var $_id;

/**

* Function Description

*

* @copyright (Only specify if different to the top @copyright)

* @author

* @todo (Use @todo as current on going tasks or projects with in the current file)

* (Correct use of the @todo will result in quicker bug fixing and will help keep the file up to date)

* Example of a correctly formated todo - "@todo Date Added - Task Name"

*

* @see (Use @see tag to document reference to code with another files if needed)

* (Please use the @see tag in all the files you wish to link to help outline the section within the code)

*

* @access (define if the method is public or private here)

* @param

* @return

*/

}

?>