1
redheadedrod
Question about SVN updates

In the files there is a portion of the header that contains the version and poster of that file. How is this done?

For instance in class/database/database.php file in the main header of the file we have the lines:

* @copyright       The XOOPS project http://sourceforge.net/projects/xoops/
 
* @license         GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
 
* @package         kernel
 
* @subpackage      database
 
* @since           1.0.0
 
* @author          Kazumi Ono <onokazu@xoops.org>
 * @
version         $Iddatabase.php 8066 2011-11-06 05:09:33Z beckmi $
 */


I am referring to the @version line.

I am cleaning up my mysqli connector this weekend for 2.5.6 and 2.6 and hope to post is shortly but wanted to make sure this line gets updated.

Using TortoiseSVN for my commits and updates.

2
Mamba
Re: Question about SVN updates
  • 2013/8/3 17:06

  • Mamba

  • Moderator

  • Posts: 11366

  • Since: 2004/4/23


This is the standard header that we should use moving forward. It's been adjusted to minimize errors on PHP Code Sniffer

/**
 * Module: XoopsTube
 *
 * You may not change or alter any portion of this comment or credits
 * of supporting developers from this source code or any supporting source code
 * which is considered copyrighted (c) material of the original comment or credit authors.
 *
 * PHP version 5
 *
 * @category        Module
 * @package         Xoopstube
 * @author          XOOPS Development Team
 * @copyright       2001-2013 The XOOPS Project
 * @license         GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @version         $Id$
 * @link            http://sourceforge.net/projects/xoops/
 * @since           1.0.6
 */


Personally I would recommend to all developers to use as author the "XOOPS Development Team", and add your name to the changes listed in "changelog.txt".

For background for this, please watch this excellent video at 19:30





The whole video is excellent!

Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

3
redheadedrod
Re: Question about SVN updates

Duly noted and will adjust files accordingly.

If I understand correctly the @author tag can have more than 1 entry.

One note about the author tag..

What might make more sense is a slightly different version of what you say.

XOOPS Development Team - for core related stuff...

For an individual module it might make more sense to do something like this...
For instance xoopspoll

XOOPSPoll Development Team

or for the module you listed
Xoopstube Development Team

Login

Who's Online

147 user(s) are online (120 user(s) are browsing Support Forums)


Members: 0


Guests: 147


more...

Donat-O-Meter

Stats
Goal: $100.00
Due Date: Apr 30
Gross Amount: $0.00
Net Balance: $0.00
Left to go: $100.00
Make donations with PayPal!

Latest GitHub Commits