Task #5522
check and streamline file- and class-comments
| Status: | Resolved | Start date: | 2009-11-27 | |
|---|---|---|---|---|
| Priority: | Must have | Due date: | ||
| Assignee: | Thomas Hempel | % Done: | 100% |
|
| Category: | Documentation | |||
| Target version: | Alpha 3 | |||
| Votes: | 0 |
Description
All files have to be checked and the class and file comments should be streamlined. I will add a draft below.
Associated revisions
- [caretaker] Added SVN property Id to files
- [caretaker_instance] Touched almost every PHP file and streamlined the comment on top of every file
- [caretaker_instance] Added SVN property Id to files
- Fixes #5522
History
Updated by Martin Ficzel over 3 years ago
I suggest this header for the caretaker files
/**
* This is a file of the caretaker project.
* Copyright 2008 by n@work and networkteam
*
* @sponsor n@work http://www.work.de
* @sponsor networkteam http://www.networkteam.com/
*
* @author Thomas Hempel <thomas@work.de>
* @author Martin Ficzel <martin@work.de>
* @author Tobias Liebig <liebig@networkteam.com>
* @author Christopher Hlubek <hlubek@networkteam.com>
*
* $$Id: class.tx_caretaker_typo3_extensions.php 33 2008-06-13 14:00:38Z thomas $$
*/
/***************************************************************
* Copyright notice
*
* (c) 2009 2008 by n@work and networkteam
* http://www.work.de
* http://www.networkteam.com/
*
* All rights reserved
*
* This script is part of the TYPO3 project. The TYPO3 project is
* free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* The GNU General Public License can be found at
* http://www.gnu.org/copyleft/gpl.html.
*
* This script is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
* This describes the foo class
*
* @see
*/
class foo {
...
}
Updated by Thomas Hempel over 3 years ago
I'm not sure about that @sponsor annotation. It's not an official annotation and I think it would be enough to just add some sponsored by block:
Something like:
/** * This is a file of the caretaker project. * Copyright 2008 by n@work and networkteam * * Sponsored by: * n@work http://www.work.de * networkteam http://www.networkteam.com/ * * @author Thomas Hempel <thomas@work.de> * @author Martin Ficzel <martin@work.de> * @author Tobias Liebig <liebig@networkteam.com> * @author Christopher Hlubek <hlubek@networkteam.com> * * $$Id: class.tx_caretaker_typo3_extensions.php 33 2008-06-13 14:00:38Z thomas $$ */
Updated by Tobias Liebig over 3 years ago
After discussion in our "Wave" i like to suggest this header:
/***************************************************************
* Copyright notice
*
* (c) 2009 by n@work and networkteam
* http://www.work.de
* http://www.networkteam.com/
*
* All rights reserved
*
* This script is part of the TYPO3 project. The TYPO3 project is
* free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* The GNU General Public License can be found at
* http://www.gnu.org/copyleft/gpl.html.
*
* This script is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
* This is a file of the caretaker project.
*
* Project sponsored by:
* n@work GmbH - http://www.work.de
* networkteam GmbH - http://www.networkteam.com/
*
* $Id$
*/
/**
* This describes the foo class
*
* @author Thomas Hempel <thomas@work.de>
* @author Martin Ficzel <martin@work.de>
* @author Tobias Liebig <liebig@networkteam.com>
* @author Christopher Hlubek <hlubek@networkteam.com>
*
*/
class foo {
...
}
Updated by Christopher Hlubek over 3 years ago
My new proposal:
/***************************************************************
* Copyright notice
*
* (c) 2009 by n@work GmbH and networkteam GmbH
*
* All rights reserved
*
* This script is part of the Caretaker project. The Caretaker project
* is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* The GNU General Public License can be found at
* http://www.gnu.org/copyleft/gpl.html.
*
* This script is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
* This is a file of the caretaker project.
*
* Project sponsored by:
* n@work GmbH - http://www.work.de
* networkteam GmbH - http://www.networkteam.com/
*
* $Id$
*/
/**
* This describes the foo class
*
* @author Martin Ficzel <martin@work.de>
* @author Thomas Hempel <thomas@work.de>
* @author Christopher Hlubek <hlubek@networkteam.com>
* @author Tobias Liebig <liebig@networkteam.com>
*
* @package TYPO3
* @subpackage caretaker
*/
class foo {
...
}
Updated by Martin Ficzel over 3 years ago
- Assignee set to Martin Ficzel
So after the short wave discussion i think we generally agreed on this header:
/***************************************************************
* Copyright notice
*
* (c) 2009 by n@work GmbH and networkteam GmbH
*
* All rights reserved
*
* This script is part of the Caretaker project. The Caretaker project
* is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* The GNU General Public License can be found at
* http://www.gnu.org/copyleft/gpl.html.
*
* This script is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/
/**
* This is a file of the caretaker project.
* http://forge.typo3.org/projects/show/extension-caretaker
*
* Project sponsored by:
* n@work GmbH - http://www.work.de
* networkteam GmbH - http://www.networkteam.com/
*
* $Id$
*/
/**
* This describes the foo class
*
* @author Martin Ficzel <martin@work.de>
* @author Thomas Hempel <thomas@work.de>
* @author Christopher Hlubek <hlubek@networkteam.com>
* @author Tobias Liebig <liebig@networkteam.com>
*
* @package TYPO3
* @subpackage caretaker
*/
class foo {
... }
I will take this task and go over the classes in caretaker core.
Updated by Martin Ficzel over 3 years ago
- Assignee deleted (
Martin Ficzel)
I updated the headers for the folders classes and services i caretaker-core. Someone who knows the caretaker_instance classes should do it there aswell.
Updated by Martin Ficzel about 3 years ago
- Target version changed from Alpha 1 to Alpha 2
I moved the ticket to alpha 2 since alpha 1 is already in TER.
Updated by Thomas Hempel over 2 years ago
- Category set to Documentation
- Status changed from New to Accepted
- Assignee set to Thomas Hempel
- Target version changed from Alpha 2 to Alpha 3
I'll check all classes and update the info
Updated by Thomas Hempel over 2 years ago
- Status changed from Accepted to Resolved
- % Done changed from 0 to 100
Applied in changeset r43024.