Please note the following:
- This article is supporting documentation for our tutorial, using DocBlocks in Joomla.
- There is official documentation that references what headers to use in your DocBlocks (such as @copyright and @license), but documentation is missing that outlines what values to use for each header.
- In an effort to learn what values to use per each header, we have scanned the Joomla code and pulled out how each header is used. The idea behind this page is to show you how the @author tag has been used in the past within the Joomla code so learn how to use it in your future documentation.
Value Count
The following table shows the various different values for @author, and how many times each value has been used.
Andreas Gohr <[email protected]>
This tag:
* @author Andreas Gohr <[email protected]>
has been used a total of 7 times within the following files:
libraries/phputf8/utils/specials.php:* @author Andreas Gohr <[email protected]> libraries/phputf8/utils/ascii.php:* @author Andreas Gohr <[email protected]> libraries/phputf8/trim.php:* @author Andreas Gohr <[email protected]> libraries/phputf8/trim.php:* @author Andreas Gohr <[email protected]> libraries/phputf8/trim.php:* @author Andreas Gohr <[email protected]> libraries/phputf8/native/core.php:* @author Andreas Gohr <[email protected]> libraries/phputf8/native/core.php:* @author Andreas Gohr <[email protected]>
Fabien Potencier <[email protected]>
This tag:
* @author Fabien Potencier <[email protected]>
has been used a total of 7 times within the following files:
libraries/framework/Symfony/Component/Yaml/Parser.php: * @author Fabien Potencier <[email protected]> libraries/framework/Symfony/Component/Yaml/Yaml.php: * @author Fabien Potencier <[email protected]> libraries/framework/Symfony/Component/Yaml/Dumper.php: * @author Fabien Potencier <[email protected]> libraries/framework/Symfony/Component/Yaml/Inline.php: * @author Fabien Potencier <[email protected]> libraries/framework/Symfony/Component/Yaml/Exception/DumpException.php: * @author Fabien Potencier <[email protected]> libraries/framework/Symfony/Component/Yaml/Exception/ParseException.php: * @author Fabien Potencier <[email protected]> libraries/framework/Symfony/Component/Yaml/Exception/ExceptionInterface.php: * @author Fabien Potencier <[email protected]>
<[email protected]>
This tag:
* @author <[email protected]>
has been used a total of 5 times within the following files:
libraries/phputf8/utils/unicode.php:* @author <[email protected]> libraries/phputf8/utils/unicode.php:* @author <[email protected]> libraries/phputf8/utils/bad.php:* @author <[email protected]> libraries/phputf8/utils/validation.php:* @author <[email protected]> libraries/joomla/string/string.php: * @author <[email protected]>
Andy Prevost
This tag:
* @author Andy Prevost
has been used a total of 4 times within the following files:
libraries/phpmailer/phpmailer.php: * @author Andy Prevost libraries/phpmailer/smtp.php: * @author Andy Prevost libraries/phpmailer/pop3.php: * @author Andy Prevost libraries/phpmailer/pop3.php: * @author Andy Prevost
Chris Smith<[email protected]>
This tag:
* @author Chris Smith<[email protected]>
has been used a total of 4 times within the following files:
libraries/phputf8/utils/position.php:* @author Chris Smith<[email protected]> libraries/phputf8/utils/position.php:* @author Chris Smith<[email protected]> libraries/phputf8/utils/position.php:* @author Chris Smith<[email protected]> libraries/phputf8/native/core.php:* @author Chris Smith<[email protected]>
Jim Jagielski
This tag:
* @author Jim Jagielski
has been used a total of 4 times within the following files:
libraries/phpmailer/phpmailer.php: * @author Jim Jagielski libraries/phpmailer/smtp.php: * @author Jim Jagielski libraries/phpmailer/pop3.php: * @author Jim Jagielski libraries/phpmailer/pop3.php: * @author Jim Jagielski
Harald Kirschner <mail [at] digitarald.de>
This tag:
* @author Harald Kirschner <mail [at] digitarald.de>
has been used a total of 3 times within the following files:
media/system/css/modal.css: * @author Harald Kirschner <mail [at] digitarald.de> media/system/js/modal.js: @author Harald Kirschner <mail [at] digitarald.de> media/system/js/modal-uncompressed.js: * @author Harald Kirschner <mail [at] digitarald.de>
Rouven We�ling <me [at] rouvenwessling.de>
This tag:
* @author Rouven We�ling <me [at] rouvenwessling.de>
has been used a total of 3 times within the following files:
media/system/css/modal.css: * @author Rouven We�ling <me [at] rouvenwessling.de> media/system/js/modal.js: @author Rouven We�ling <me [at] rouvenwessling.de> media/system/js/modal-uncompressed.js: * @author Rouven We�ling <me [at] rouvenwessling.de>
Matthias Sommerfeld <[email protected]>
This tag:
* @author Matthias Sommerfeld <[email protected]>
has been used a total of 3 times within the following files:
libraries/simplepie/idn/idna_convert.class.php: * @author Matthias Sommerfeld <[email protected]> libraries/simplepie/idn/idna_convert.class.php:* @author Matthias Sommerfeld <[email protected]> libraries/idna_convert/idna_convert.class.php: * @author Matthias Sommerfeld <[email protected]>
Marcus Bointon
This tag:
* @author Marcus Bointon
has been used a total of 3 times within the following files:
libraries/phpmailer/phpmailer.php: * @author Marcus Bointon libraries/phpmailer/smtp.php: * @author Marcus Bointon libraries/phpmailer/pop3.php: * @author Marcus Bointon
Geoffrey Sneddon
This tag:
* @author Geoffrey Sneddon
has been used a total of 2 times within the following files:
libraries/simplepie/simplepie.php: * @author Geoffrey Sneddon libraries/simplepie/simplepie.php: * @author Geoffrey Sneddon
Anthony Ferrara <[email protected]>
This tag:
* @author Anthony Ferrara <[email protected]>
has been used a total of 2 times within the following files:
libraries/compat/password/lib/version_test.php: * @author Anthony Ferrara <[email protected]> libraries/compat/password/lib/password.php: * @author Anthony Ferrara <[email protected]>
Matthew Lewinski <[email protected]>
This tag:
* @author Matthew Lewinski <[email protected]>
has been used a total of 2 times within the following files:
libraries/framework/Symfony/Component/Yaml/Unescaper.php: * @author Matthew Lewinski <[email protected]> libraries/framework/Symfony/Component/Yaml/Escaper.php: * @author Matthew Lewinski <[email protected]>
Romain Neutron <[email protected]>
This tag:
* @author Romain Neutron <[email protected]>
has been used a total of 1 times within the following files:
libraries/framework/Symfony/Component/Yaml/Exception/RuntimeException.php: * @author Romain Neutron <[email protected]>
Jay Burrell, Systems & Networks, Mississippi State University
This tag:
* @author Jay Burrell, Systems & Networks, Mississippi State University
has been used a total of 1 times within the following files:
libraries/joomla/client/ldap.php: * @author Jay Burrell, Systems & Networks, Mississippi State University
Oliver Saunders <oliver (a) osinternetservices.com>
This tag:
* @author Oliver Saunders <oliver (a) osinternetservices.com>
has been used a total of 1 times within the following files:
libraries/phputf8/str_pad.php:* @author Oliver Saunders <oliver (a) osinternetservices.com>
Matthias Sommerfeld, <[email protected]>
This tag:
* @author Matthias Sommerfeld, <[email protected]>
has been used a total of 1 times within the following files:
libraries/idna_convert/transcode_wrapper.php: * @author Matthias Sommerfeld, <[email protected]>
Matthias Sommerfeld <[email protected]>
This tag:
* @author Matthias Sommerfeld <[email protected]>
has been used a total of 1 times within the following files:
libraries/idna_convert/uctc.php: * @author Matthias Sommerfeld <[email protected]>
<chernyshevsky at hotmail dot com>
This tag:
* @author <chernyshevsky at hotmail dot com>
has been used a total of 1 times within the following files:
libraries/phputf8/native/core.php:* @author <chernyshevsky at hotmail dot com>
elfrink at introweb dot nl
This tag:
* @author elfrink at introweb dot nl
has been used a total of 1 times within the following files:
libraries/simplepie/simplepie.php: * @author elfrink at introweb dot nl
Nicholas
This tag:
* @author Nicholas
has been used a total of 1 times within the following files:
administrator/components/com_joomlaupdate/restore.php: * @author Nicholas
Nicholas K. Dionysopoulos
This tag:
* @author Nicholas K. Dionysopoulos
has been used a total of 1 times within the following files:
administrator/components/com_joomlaupdate/restore.php: * @author Nicholas K. Dionysopoulos
Brett Stimmerman <brettstimmerman[at]gmail[dot]com>
This tag:
* @author Brett Stimmerman <brettstimmerman[at]gmail[dot]com>
has been used a total of 1 times within the following files:
administrator/components/com_joomlaupdate/restore.php: * @author Brett Stimmerman <brettstimmerman[at]gmail[dot]com>
Matt Knapp <mdknapp[at]gmail[dot]com>
This tag:
* @author Matt Knapp <mdknapp[at]gmail[dot]com>
has been used a total of 1 times within the following files:
administrator/components/com_joomlaupdate/restore.php: * @author Matt Knapp <mdknapp[at]gmail[dot]com>
Michal Migurski <[email protected]>
This tag:
* @author Michal Migurski <[email protected]>
has been used a total of 1 times within the following files:
administrator/components/com_joomlaupdate/restore.php: * @author Michal Migurski <[email protected]>
Chris Ryan
This tag:
* @author Chris Ryan
has been used a total of 1 times within the following files:
libraries/phpmailer/smtp.php: * @author Chris Ryan
Richard Davey (orig) <[email protected]>
This tag:
* @author Richard Davey (orig) <[email protected]>
has been used a total of 1 times within the following files:
libraries/phpmailer/pop3.php: * @author Richard Davey (orig) <[email protected]>
Josh Peck <jmp at joshpeck dot org>
This tag:
* @author Josh Peck <jmp at joshpeck dot org>
has been used a total of 1 times within the following files:
libraries/simplepie/simplepie.php: * @author Josh Peck <jmp at joshpeck dot org>
nikosdion <[email protected]>
This tag:
* @author nikosdion <[email protected]>
has been used a total of 1 times within the following files:
administrator/components/com_joomlaupdate/models/default.php: * @author nikosdion <[email protected]>
Alexander Merz <[email protected]>
This tag:
* @author Alexander Merz <[email protected]>
has been used a total of 1 times within the following files:
libraries/simplepie/simplepie.php: * @author Alexander Merz <[email protected]>
Ryan Parman
This tag:
* @author Ryan Parman
has been used a total of 1 times within the following files:
libraries/simplepie/simplepie.php: * @author Ryan Parman
Geoffrey Sneddon <[email protected]>
This tag:
* @author Geoffrey Sneddon <[email protected]>
has been used a total of 1 times within the following files:
libraries/simplepie/simplepie.php: * @author Geoffrey Sneddon <[email protected]>
