@author – Joomla DocBlock headers

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.

Value # Times used
* @author Andreas Gohr <andi@splitbrain.org> 7
* @author Fabien Potencier <fabien@symfony.com> 7
* @author <hsivonen@iki.fi> 5
* @author Andy Prevost 4
* @author Chris Smith<chris@jalakai.co.uk> 4
* @author Jim Jagielski 4
* @author Harald Kirschner <mail [at] digitarald.de> 3
* @author Rouven We�ling <me [at] rouvenwessling.de> 3
* @author Matthias Sommerfeld <mso@phlylabs.de> 3
* @author Marcus Bointon 3
* @author Geoffrey Sneddon 2
* @author Anthony Ferrara <ircmaxell@php.net> 2
* @author Matthew Lewinski <matthew@lewinski.org> 2
* @author Romain Neutron <imprec@gmail.com> 1
* @author Jay Burrell, Systems & Networks, Mississippi State University 1
* @author Oliver Saunders <oliver (a) osinternetservices.com> 1
* @author Matthias Sommerfeld, <mso@phlylabs.de> 1
* @author Matthias Sommerfeld <mso@phlyLabs.de> 1
* @author <chernyshevsky at hotmail dot com> 1
* @author elfrink at introweb dot nl 1
* @author Nicholas 1
* @author Nicholas K. Dionysopoulos 1
* @author Brett Stimmerman <brettstimmerman[at]gmail[dot]com> 1
* @author Matt Knapp <mdknapp[at]gmail[dot]com> 1
* @author Michal Migurski <mike-json@teczno.com> 1
* @author Chris Ryan 1
* @author Richard Davey (orig) <rich@corephp.co.uk> 1
* @author Josh Peck <jmp at joshpeck dot org> 1
* @author nikosdion <nicholas@dionysopoulos.me> 1
* @author Alexander Merz <alexander.merz@web.de> 1
* @author Ryan Parman 1
* @author Geoffrey Sneddon <geoffers@gmail.com> 1

Andreas Gohr <andi@splitbrain.org>

This tag:
* @author Andreas Gohr <andi@splitbrain.org>
has been used a total of 7 times within the following files:

libraries/phputf8/utils/specials.php:* @author Andreas Gohr <andi@splitbrain.org> libraries/phputf8/utils/ascii.php:* @author Andreas Gohr <andi@splitbrain.org> libraries/phputf8/trim.php:* @author Andreas Gohr <andi@splitbrain.org> libraries/phputf8/trim.php:* @author Andreas Gohr <andi@splitbrain.org> libraries/phputf8/trim.php:* @author Andreas Gohr <andi@splitbrain.org> libraries/phputf8/native/core.php:* @author Andreas Gohr <andi@splitbrain.org> libraries/phputf8/native/core.php:* @author Andreas Gohr <andi@splitbrain.org> 

Fabien Potencier <fabien@symfony.com>

This tag:
* @author Fabien Potencier <fabien@symfony.com>
has been used a total of 7 times within the following files:

libraries/framework/Symfony/Component/Yaml/Parser.php: * @author Fabien Potencier <fabien@symfony.com> libraries/framework/Symfony/Component/Yaml/Yaml.php: * @author Fabien Potencier <fabien@symfony.com> libraries/framework/Symfony/Component/Yaml/Dumper.php: * @author Fabien Potencier <fabien@symfony.com> libraries/framework/Symfony/Component/Yaml/Inline.php: * @author Fabien Potencier <fabien@symfony.com> libraries/framework/Symfony/Component/Yaml/Exception/DumpException.php: * @author Fabien Potencier <fabien@symfony.com> libraries/framework/Symfony/Component/Yaml/Exception/ParseException.php: * @author Fabien Potencier <fabien@symfony.com> libraries/framework/Symfony/Component/Yaml/Exception/ExceptionInterface.php: * @author Fabien Potencier <fabien@symfony.com> 

<hsivonen@iki.fi>

This tag:
* @author <hsivonen@iki.fi>
has been used a total of 5 times within the following files:

libraries/phputf8/utils/unicode.php:* @author <hsivonen@iki.fi> libraries/phputf8/utils/unicode.php:* @author <hsivonen@iki.fi> libraries/phputf8/utils/bad.php:* @author <hsivonen@iki.fi> libraries/phputf8/utils/validation.php:* @author <hsivonen@iki.fi> libraries/joomla/string/string.php:   * @author  <hsivonen@iki.fi> 

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<chris@jalakai.co.uk>

This tag:
* @author Chris Smith<chris@jalakai.co.uk>
has been used a total of 4 times within the following files:

libraries/phputf8/utils/position.php:* @author Chris Smith<chris@jalakai.co.uk> libraries/phputf8/utils/position.php:* @author Chris Smith<chris@jalakai.co.uk> libraries/phputf8/utils/position.php:* @author Chris Smith<chris@jalakai.co.uk> libraries/phputf8/native/core.php:* @author Chris Smith<chris@jalakai.co.uk> 

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 <mso@phlylabs.de>

This tag:
* @author Matthias Sommerfeld <mso@phlylabs.de>
has been used a total of 3 times within the following files:

libraries/simplepie/idn/idna_convert.class.php: * @author  Matthias Sommerfeld <mso@phlylabs.de> libraries/simplepie/idn/idna_convert.class.php:* @author  Matthias Sommerfeld <mso@phlylabs.de> libraries/idna_convert/idna_convert.class.php: * @author  Matthias Sommerfeld <mso@phlylabs.de> 

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 <ircmaxell@php.net>

This tag:
* @author Anthony Ferrara <ircmaxell@php.net>
has been used a total of 2 times within the following files:

libraries/compat/password/lib/version_test.php: * @author Anthony Ferrara <ircmaxell@php.net> libraries/compat/password/lib/password.php: * @author Anthony Ferrara <ircmaxell@php.net> 

Matthew Lewinski <matthew@lewinski.org>

This tag:
* @author Matthew Lewinski <matthew@lewinski.org>
has been used a total of 2 times within the following files:

libraries/framework/Symfony/Component/Yaml/Unescaper.php: * @author Matthew Lewinski <matthew@lewinski.org> libraries/framework/Symfony/Component/Yaml/Escaper.php: * @author Matthew Lewinski <matthew@lewinski.org> 

Romain Neutron <imprec@gmail.com>

This tag:
* @author Romain Neutron <imprec@gmail.com>
has been used a total of 1 times within the following files:

libraries/framework/Symfony/Component/Yaml/Exception/RuntimeException.php: * @author Romain Neutron <imprec@gmail.com> 

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, <mso@phlylabs.de>

This tag:
* @author Matthias Sommerfeld, <mso@phlylabs.de>
has been used a total of 1 times within the following files:

libraries/idna_convert/transcode_wrapper.php: * @author Matthias Sommerfeld, <mso@phlylabs.de> 

Matthias Sommerfeld <mso@phlyLabs.de>

This tag:
* @author Matthias Sommerfeld <mso@phlyLabs.de>
has been used a total of 1 times within the following files:

libraries/idna_convert/uctc.php: * @author Matthias Sommerfeld  <mso@phlyLabs.de> 

<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 <mike-json@teczno.com>

This tag:
* @author Michal Migurski <mike-json@teczno.com>
has been used a total of 1 times within the following files:

administrator/components/com_joomlaupdate/restore.php: * @author      Michal Migurski <mike-json@teczno.com> 

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) <rich@corephp.co.uk>

This tag:
* @author Richard Davey (orig) <rich@corephp.co.uk>
has been used a total of 1 times within the following files:

libraries/phpmailer/pop3.php: * @author Richard Davey (orig) <rich@corephp.co.uk> 

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 <nicholas@dionysopoulos.me>

This tag:
* @author nikosdion <nicholas@dionysopoulos.me>
has been used a total of 1 times within the following files:

administrator/components/com_joomlaupdate/models/default.php: * @author      nikosdion <nicholas@dionysopoulos.me> 

Alexander Merz <alexander.merz@web.de>

This tag:
* @author Alexander Merz <alexander.merz@web.de>
has been used a total of 1 times within the following files:

libraries/simplepie/simplepie.php: * @author Alexander Merz <alexander.merz@web.de> 

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 <geoffers@gmail.com>

This tag:
* @author Geoffrey Sneddon <geoffers@gmail.com>
has been used a total of 1 times within the following files:

libraries/simplepie/simplepie.php: * @author Geoffrey Sneddon <geoffers@gmail.com> 

Leave a Reply