INFRA-132 - Fix spacing of @return tag in comments
[civicrm-core.git] / CRM / Admin / Page / APIDoc.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
39de6fd5 4 | CiviCRM version 4.6 |
6a488035 5 +--------------------------------------------------------------------+
06b69b18 6 | Copyright CiviCRM LLC (c) 2004-2014 |
6a488035
TO
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
13 | |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
18 | |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
26*/
27
28/**
29 *
30 * @package CRM
06b69b18 31 * @copyright CiviCRM LLC (c) 2004-2014
6a488035
TO
32 * $Id$
33 *
34 */
35
36/**
37 * Page for displaying list of contact Subtypes
38 */
39class CRM_Admin_Page_APIDoc extends CRM_Core_Page {
40
e0ef6999
EM
41 /**
42 * @return string
43 */
00be9182 44 public function run() {
7aecce74 45 CRM_Utils_System::setTitle(ts('API Parameters'));
6a488035
TO
46 return parent::run();
47 }
48
e0ef6999
EM
49 /**
50 * @return string
51 */
00be9182 52 public function getTemplateFileName() {
6a488035
TO
53 return 'CRM/Core/APIDoc.tpl';
54 }
55
56 /**
57 * Get user context.
58 *
77b97be7
EM
59 * @param null $mode
60 *
a6c01b45
CW
61 * @return string
62 * user context.
6a488035 63 */
00be9182 64 public function userContext($mode = NULL) {
6a488035
TO
65 return 'civicrm/api/doc';
66 }
67}