From 46dc391fb3920fe222c3fdc3a4376493e4b501a6 Mon Sep 17 00:00:00 2001 From: Jeroen De Dauw Date: Sun, 15 Jan 2012 16:13:16 +0000 Subject: [PATCH] added some docs --- includes/logging/LogEntry.php | 46 +++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/includes/logging/LogEntry.php b/includes/logging/LogEntry.php index 31ef99a156..9d94325fba 100644 --- a/includes/logging/LogEntry.php +++ b/includes/logging/LogEntry.php @@ -313,6 +313,14 @@ class ManualLogEntry extends LogEntryBase { protected $comment = ''; ///!< @var string protected $deleted; ///!< @var int + /** + * Constructor. + * + * @since 1.19 + * + * @param string $type + * @param string $subtype + */ public function __construct( $type, $subtype ) { $this->type = $type; $this->subtype = $subtype; @@ -329,28 +337,66 @@ class ManualLogEntry extends LogEntryBase { * '4:color' => 'blue', * 'animal' => 'dog' * ); + * + * @since 1.19 + * * @param $parameters Associative array */ public function setParameters( $parameters ) { $this->parameters = $parameters; } + /** + * Set the user that performed the action being logged. + * + * @since 1.19 + * + * @param User $performer + */ public function setPerformer( User $performer ) { $this->performer = $performer; } + /** + * Set the title of the object changed. + * + * @since 1.19 + * + * @param Title $target + */ public function setTarget( Title $target ) { $this->target = $target; } + /** + * Set the timestamp of when the logged action took place. + * + * @since 1.19 + * + * @param string $timestamp + */ public function setTimestamp( $timestamp ) { $this->timestamp = $timestamp; } + /** + * Set a comment associated with the action being logged. + * + * @since 1.19 + * + * @param string $comment + */ public function setComment( $comment ) { $this->comment = $comment; } + /** + * TODO: document + * + * @since 1.19 + * + * @param integer $deleted + */ public function setDeleted( $deleted ) { $this->deleted = $deleted; } -- 2.20.1