From e53a2c7578bff70715cbfb69938b6a65a4e46636 Mon Sep 17 00:00:00 2001 From: diosmosis Date: Wed, 23 Oct 2013 01:57:55 -0400 Subject: Change some @param array phpdoc tags to be @param Object[], fill in DataTableMap::deleteRow and start documenting ArchiveProcessor. --- core/ArchiveProcessor.php | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'core/ArchiveProcessor.php') diff --git a/core/ArchiveProcessor.php b/core/ArchiveProcessor.php index 1ff1fd6e9b..c594d03cfe 100644 --- a/core/ArchiveProcessor.php +++ b/core/ArchiveProcessor.php @@ -20,8 +20,19 @@ use Piwik\Db; use Piwik\Period; /** - * The ArchiveProcessor class is used by the Archive object to make sure the given Archive is processed and available in the DB. + * Used to insert numeric and blob archive data. * + * During the Archiving process a descendant of this class is used by plugins + * to cache aggregated analytics statistics. + * + * ArchiveProcessors are passed to plugins via the [ArchiveProcessor.Day.compute](#) + * and [ArchiveProcessor.Period.compute](#) events. Plugins should then the object + * to aggregate data and cache that data. + * + * ### Examples + * + * TODO + * * @package Piwik * @subpackage ArchiveProcessor */ -- cgit v1.2.3