Skip to content

Commit b40e4d1

Browse files
tsteurtsteur
committed
converted some links to use @link 
1 parent 9b12e77 commit b40e4d1

48 files changed

Lines changed: 106 additions & 107 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎core/API/Proxy.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ public function call($className, $methodName, $parametersRequest)
237237
*
238238
* @param mixed &$returnedValue The value returned from the API method. This will not be
239239
* a rendered string, but an actual object. For example, it
240-
* could be a [DataTable](#).
240+
* could be a {@link Piwik\DataTable}.
241241
* @param array $extraInfo An array holding information regarding the API request. Will
242242
* contain the following data:
243243
*

‎core/API/Request.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* and handle the **flat** and **label** query parameters.
3030
*
3131
* Additionally, the Request class will **forward current query parameters** to the request
32-
* which is more convenient than calling [Common::getRequestVar](#) many times over.
32+
* which is more convenient than calling {@link Piwik\Common::getRequestVar()} many times over.
3333
*
3434
* In most cases, using a Request object to query the API is the right way to go.
3535
*

‎core/ArchiveProcessor.php‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@
2929
*
3030
* When the {@link Archive} class is used to query for archive data and that archive
3131
* data is found to be absent, the archiving process is launched. Instances of the
32-
* [Archiver](#) classes for every plugin that supplies one are then used to
33-
* execute archiving logic.
32+
* {@link Piwik\Plugin\Archiver} classes for every plugin that supplies one are
33+
* then used to execute archiving logic.
3434
*
35-
* Plugins access ArchiveProcessor instances through the {@link Piwik\Plugin\Archiver Archiver} class.
36-
* Read the docs for {@link Piwik\Plugin\Archiver Archiver} to learn more about the process.
35+
* Plugins access ArchiveProcessor instances through the {@link Piwik\Plugin\Archiver} class.
36+
* Read the docs for {@link Piwik\Plugin\Archiver} to learn more about the process.
3737
*
3838
* ### Limitations
3939
*
@@ -43,10 +43,10 @@
4343
*
4444
* ### See also
4545
*
46-
* - **{@link Piwik\Plugin\Archiver Archiver}** - to learn how plugins should implement their own analytics
47-
* aggregation logic.
48-
* - **{@link Piwik\DataAccess\LogAggregator LogAggregator}** - to learn how plugins can perform data aggregation
49-
* across Piwik's log tables.
46+
* - **{@link Piwik\Plugin\Archiver}** - to learn how plugins should implement their own analytics
47+
* aggregation logic.
48+
* - **{@link Piwik\DataAccess\LogAggregator}** - to learn how plugins can perform data aggregation
49+
* across Piwik's log tables.
5050
*
5151
* ### Examples
5252
*
@@ -158,7 +158,7 @@ public function getParams()
158158
}
159159

160160
/**
161-
* Returns a [LogAggregator](#) instance for the site, period and segment this
161+
* Returns a `{@link Piwik\DataAccess\LogAggregator}` instance for the site, period and segment this
162162
* ArchiveProcessor will insert archive data for.
163163
*
164164
* @return LogAggregator

‎core/DataAccess/LogAggregator.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
/**
2323
* Contains methods that aggregates log data (visits, actions, conversions, ecommerce).
2424
*
25-
* Plugin [Archiver](#) descendants can use the methods in this class to aggregate data
25+
* Plugin {@link Piwik\Plugin\Archiver} descendants can use the methods in this class to aggregate data
2626
* in the log tables without creating their own SQL queries.
2727
*
2828
* ### Aggregation Principles
@@ -283,9 +283,9 @@ public function getMetricsFromVisitByDimension($dimension)
283283
* - [Metrics::INDEX_NB_VISITS_CONVERTED](#)
284284
* @param bool|\Piwik\RankingQuery $rankingQuery
285285
* A pre-configured ranking query instance that will be used to limit the result.
286-
* If set, the return value is the array returned by [RankingQuery::execute()](#).
286+
* If set, the return value is the array returned by {@link Piwik\RankingQuery::execute()}.
287287
* @return mixed A Zend_Db_Statement if `$rankingQuery` isn't supplied, otherwise the result of
288-
* [RankingQuery::execute()](#). Read [this](#queryVisitsByDimension-result-set)
288+
* {@link Piwik\RankingQuery::execute()}. Read [this](#queryVisitsByDimension-result-set)
289289
* to see what aggregate data is calculated by the query.
290290
* @api
291291
*/
@@ -556,14 +556,14 @@ public function queryEcommerceItems($dimension)
556556
* - [Metrics::INDEX_NB_ACTIONS](#)
557557
* @param bool|\Piwik\RankingQuery $rankingQuery
558558
* A pre-configured ranking query instance that will be used to limit the result.
559-
* If set, the return value is the array returned by [RankingQuery::execute()](#).
559+
* If set, the return value is the array returned by {@link Piwik\RankingQuery::execute()}.
560560
* @param bool|string $joinLogActionOnColumn One or more columns from the **log_link_visit_action** table that
561561
* log_action should be joined on. The table alias used for each join
562562
* is `"log_action$i"` where `$i` is the index of the column in this
563563
* array. If a string is used for this parameter, the table alias is not
564564
* suffixed.
565565
* @return mixed A Zend_Db_Statement if `$rankingQuery` isn't supplied, otherwise the result of
566-
* [RankingQuery::execute()](#). Read [this](#queryEcommerceItems-result-set)
566+
* {@link Piwik\RankingQuery::execute()}. Read [this](#queryEcommerceItems-result-set)
567567
* to see what aggregate data is calculated by the query.
568568
* @api
569569
*/

‎core/DataTable.php‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -89,17 +89,17 @@
8989
*
9090
* ### Applying Filters
9191
*
92-
* Filters can be applied now (via [filter](#filter)), or they can be applied later (via
93-
* [queueFilter](#queueFilter)).
92+
* Filters can be applied now (via {@link filter()}), or they can be applied later (via
93+
* {@link queueFilter()}).
9494
*
9595
* Filters that sort rows or manipulate the number of rows should be applied right away.
9696
* Non-essential, presentation filters should be queued.
9797
*
9898
* ### Learn more
9999
*
100-
* - **[ArchiveProcessor](#)** — to learn how DataTables are persisted.
101-
* - **[DataTable\Renderer](#)** — to learn how DataTable data is exported to XML, JSON, etc.
102-
* - **[DataTable\Filter](#)** — to see all core Filters.
100+
* - **{@link ArchiveProcessor}** — to learn how DataTables are persisted.
101+
* - **{@link DataTable\Renderer}** — to learn how DataTable data is exported to XML, JSON, etc.
102+
* - **{@link DataTable\Filter}** — to see all core Filters.
103103
*
104104
* ### Examples
105105
*
@@ -182,8 +182,8 @@ class DataTable implements DataTableInterface
182182
const TOTAL_ROWS_BEFORE_LIMIT_METADATA_NAME = 'total_rows_before_limit';
183183

184184
/**
185-
* Name for metadata that describes how individual columns should be aggregated when [addDataTable](#addDataTable)
186-
* or [DataTable\Row::sumRow](#) is called.
185+
* Name for metadata that describes how individual columns should be aggregated when {@link addDataTable()}
186+
* or {@link Piwik\DataTable\Row::sumRow()} is called.
187187
*
188188
* This metadata value must be an array that maps column names with valid operations. Valid aggregation operations are:
189189
*
@@ -192,7 +192,7 @@ class DataTable implements DataTableInterface
192192
* - `'min'`: does `min($column1, $column2)`
193193
* - `'sum'`: does `$column1 + $column2`
194194
*
195-
* See [addDataTable](#addDataTable) and [DataTable\Row::sumRow](#) for more information.
195+
* See {@link addDataTable()} and {@link DataTable\Row::sumRow()} for more information.
196196
*/
197197
const COLUMN_AGGREGATION_OPS_METADATA_NAME = 'column_aggregation_ops';
198198

@@ -1055,7 +1055,7 @@ public static function isEqual(DataTable $table1, DataTable $table2)
10551055
* cases where DataTables can become quite large, they should be truncated before being persisted
10561056
* in an archive.
10571057
*
1058-
* The result of this method is intended for use with the [ArchiveProcessor::insertBlobRecord](#) method.
1058+
* The result of this method is intended for use with the {@link ArchiveProcessor::insertBlobRecord()} method.
10591059
*
10601060
* @throws Exception If infinite recursion detected. This will occur if a table's subtable is one of its parent tables.
10611061
* @param int $maximumRowsInDataTable If not null, defines the maximum number of rows allowed in the serialized DataTable.

‎core/DataTable/Filter.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
* - etc.
2424
*
2525
* Filters are called with a DataTable instance and extra parameters that are specified
26-
* in [DataTable::filter()](#) and [DataTable::queueFilter()](#).
26+
* in {@link Piwik\DataTable::filter()} and {@link Piwik\DataTable::queueFilter()}.
2727
*
2828
* To see examples of Filters look at the existing ones in the Piwik\DataTable\Filter
2929
* namespace.

‎core/DataTable/Filter/AddColumnsProcessedMetrics.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
* Adding the **filter_add_columns_when_show_all_columns** query parameter to
3030
* an API request will trigger the execution of this Filter.
3131
*
32-
* _Note: This filter must be called before [ReplaceColumnNames](#) is called._
32+
* _Note: This filter must be called before {@link ReplaceColumnNames} is called._
3333
*
3434
* **Basic usage example**
3535
*

‎core/DataTable/Filter/AddColumnsProcessedMetricsGoal.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
* Adding the **filter_update_columns_when_show_all_goals** query parameter to
4343
* an API request will trigger the execution of this Filter.
4444
*
45-
* Note: This filter must be called before [ReplaceColumnNames](#) is called.
45+
* Note: This filter must be called before {@link ReplaceColumnNames} is called.
4646
*
4747
* **Basic usage example**
4848
*

‎core/DataTable/Filter/AddSummaryRow.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public function __construct($table, $labelSummaryRow = DataTable::LABEL_SUMMARY_
4444
}
4545

4646
/**
47-
* Executes the filter. See [AddSummaryRow](#).
47+
* Executes the filter. See {@link AddSummaryRow}.
4848
*
4949
* @param DataTable $table
5050
*/

‎core/DataTable/Filter/BeautifyRangeLabels.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
*
3030
* This filter can be extended to vary exactly how ranges are prettified based
3131
* on the range values found in the DataTable. To see an example of this,
32-
* take a look at the [BeautifyTimeRangeLabels](#) filter.
32+
* take a look at the {@link BeautifyTimeRangeLabels} filter.
3333
*
3434
* **Basic usage example**
3535
*
@@ -73,7 +73,7 @@ public function __construct($table, $labelSingular, $labelPlural)
7373
}
7474

7575
/**
76-
* Beautifies a range label and returns the pretty result. See [BeautifyRangeLabels](#).
76+
* Beautifies a range label and returns the pretty result. See {@link BeautifyRangeLabels}.
7777
*
7878
* @param string $value The range string. This must be in either a '$min-$max' format
7979
* a '$min+' format.

0 commit comments

Comments
 (0)