I was wondering what file header to use for new files.
Should it contain the © of the original author ?
When I modify some files, should I add myself with an @author
tag or something ?
Or..
Could we just stick to the OSM header ?
/**
* @package JTracker
* @subpackage ?
*
* @copyright Copyright (C) 2012 - 2012 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
It's never too late (or too early) for this kind of ugly discussions ;)
This sounds like a good plan.
Just to be clear: All I want to ensure is, that this software we are creating here stays free (as in beer)... and can be "used" and modified as a whole, or in parts, by any entity in this, and any other still unknown, universe.
Nothing less ;)
It's built on the J! Platform. Inherently, that makes it GPL. So, feel free to do with the code as you please. At least, that's the way I look at it.
Closing this. I went through and standardized all the file headers yesterday. Let's stick with that pattern (@author
tags are welcome too as I said before) for now and in the off chance something funny comes up, we can change it.
Agreed ;)
Honestly, I hadn't thought that far. I just slapped my own on at the beginning since that was the quickest thing for me.
I think for
@package
, JTracker works fine for everything that isn't an import from the CMS (and maybe that stance can be thought about again depending on how much CMS stuff is changed). For@subpackage
, I think something like what the CMS does should work (so com_tracker for all the component files, whatever layer it is in the libraries/tracker folder for those files, etc.).Copyright, that's a tricky one. Technically, this isn't an OSM owned product right now. Definitely something to think about or at least ask around for advice on.
For the class doc block, I think we can add the
@author
tag there in addition to the "standard"@package
,@subpackage
, and@since
.