1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-12-19 12:00:55 +01:00

Slightly improve Maniphest documentation.

This commit is contained in:
epriestley 2011-07-04 13:04:22 -07:00
parent a5e22e87e2
commit 78c695bad2
35 changed files with 164 additions and 17 deletions

View file

@ -261,6 +261,7 @@ phutil_register_library_map(array(
'LiskIsolationTestCase' => 'storage/lisk/dao/__tests__', 'LiskIsolationTestCase' => 'storage/lisk/dao/__tests__',
'LiskIsolationTestDAO' => 'storage/lisk/dao/__tests__', 'LiskIsolationTestDAO' => 'storage/lisk/dao/__tests__',
'LiskIsolationTestDAOException' => 'storage/lisk/dao/__tests__', 'LiskIsolationTestDAOException' => 'storage/lisk/dao/__tests__',
'ManiphestConstants' => 'applications/maniphest/constants/base',
'ManiphestController' => 'applications/maniphest/controller/base', 'ManiphestController' => 'applications/maniphest/controller/base',
'ManiphestDAO' => 'applications/maniphest/storage/base', 'ManiphestDAO' => 'applications/maniphest/storage/base',
'ManiphestReplyHandler' => 'applications/maniphest/replyhandler', 'ManiphestReplyHandler' => 'applications/maniphest/replyhandler',
@ -283,6 +284,7 @@ phutil_register_library_map(array(
'ManiphestTransactionPreviewController' => 'applications/maniphest/controller/transactionpreview', 'ManiphestTransactionPreviewController' => 'applications/maniphest/controller/transactionpreview',
'ManiphestTransactionSaveController' => 'applications/maniphest/controller/transactionsave', 'ManiphestTransactionSaveController' => 'applications/maniphest/controller/transactionsave',
'ManiphestTransactionType' => 'applications/maniphest/constants/transactiontype', 'ManiphestTransactionType' => 'applications/maniphest/constants/transactiontype',
'ManiphestView' => 'applications/maniphest/view/base',
'Phabricator404Controller' => 'applications/base/controller/404', 'Phabricator404Controller' => 'applications/base/controller/404',
'PhabricatorAuthController' => 'applications/auth/controller/base', 'PhabricatorAuthController' => 'applications/auth/controller/base',
'PhabricatorConduitAPIController' => 'applications/conduit/controller/api', 'PhabricatorConduitAPIController' => 'applications/conduit/controller/api',
@ -766,14 +768,19 @@ phutil_register_library_map(array(
'ManiphestTaskDetailController' => 'ManiphestController', 'ManiphestTaskDetailController' => 'ManiphestController',
'ManiphestTaskEditController' => 'ManiphestController', 'ManiphestTaskEditController' => 'ManiphestController',
'ManiphestTaskListController' => 'ManiphestController', 'ManiphestTaskListController' => 'ManiphestController',
'ManiphestTaskListView' => 'AphrontView', 'ManiphestTaskListView' => 'ManiphestView',
'ManiphestTaskOwner' => 'ManiphestConstants',
'ManiphestTaskPriority' => 'ManiphestConstants',
'ManiphestTaskProject' => 'ManiphestDAO', 'ManiphestTaskProject' => 'ManiphestDAO',
'ManiphestTaskSummaryView' => 'AphrontView', 'ManiphestTaskStatus' => 'ManiphestConstants',
'ManiphestTaskSummaryView' => 'ManiphestView',
'ManiphestTransaction' => 'ManiphestDAO', 'ManiphestTransaction' => 'ManiphestDAO',
'ManiphestTransactionDetailView' => 'AphrontView', 'ManiphestTransactionDetailView' => 'ManiphestView',
'ManiphestTransactionListView' => 'AphrontView', 'ManiphestTransactionListView' => 'ManiphestView',
'ManiphestTransactionPreviewController' => 'ManiphestController', 'ManiphestTransactionPreviewController' => 'ManiphestController',
'ManiphestTransactionSaveController' => 'ManiphestController', 'ManiphestTransactionSaveController' => 'ManiphestController',
'ManiphestTransactionType' => 'ManiphestConstants',
'ManiphestView' => 'AphrontView',
'Phabricator404Controller' => 'PhabricatorController', 'Phabricator404Controller' => 'PhabricatorController',
'PhabricatorAuthController' => 'PhabricatorController', 'PhabricatorAuthController' => 'PhabricatorController',
'PhabricatorConduitAPIController' => 'PhabricatorConduitController', 'PhabricatorConduitAPIController' => 'PhabricatorConduitController',

View file

@ -0,0 +1,24 @@
<?php
/*
* Copyright 2011 Facebook, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @group maniphest
*/
class ManiphestConstants {
}

View file

@ -0,0 +1,10 @@
<?php
/**
* This file is automatically generated. Lint this module to rebuild it.
* @generated
*/
phutil_require_source('ManiphestConstants.php');

View file

@ -16,7 +16,10 @@
* limitations under the License. * limitations under the License.
*/ */
final class ManiphestTaskOwner { /**
* @group maniphest
*/
final class ManiphestTaskOwner extends ManiphestConstants {
const OWNER_UP_FOR_GRABS = 'PHID-!!!!-UP-FOR-GRABS'; const OWNER_UP_FOR_GRABS = 'PHID-!!!!-UP-FOR-GRABS';

View file

@ -6,5 +6,7 @@
phutil_require_module('phabricator', 'applications/maniphest/constants/base');
phutil_require_source('ManiphestTaskOwner.php'); phutil_require_source('ManiphestTaskOwner.php');

View file

@ -16,7 +16,10 @@
* limitations under the License. * limitations under the License.
*/ */
final class ManiphestTaskPriority { /**
* @group maniphest
*/
final class ManiphestTaskPriority extends ManiphestConstants {
const PRIORITY_UNBREAK_NOW = 100; const PRIORITY_UNBREAK_NOW = 100;
const PRIORITY_TRIAGE = 90; const PRIORITY_TRIAGE = 90;

View file

@ -6,6 +6,8 @@
phutil_require_module('phabricator', 'applications/maniphest/constants/base');
phutil_require_module('phutil', 'utils'); phutil_require_module('phutil', 'utils');

View file

@ -16,7 +16,10 @@
* limitations under the License. * limitations under the License.
*/ */
final class ManiphestTaskStatus { /**
* @group maniphest
*/
final class ManiphestTaskStatus extends ManiphestConstants {
const STATUS_OPEN = 0; const STATUS_OPEN = 0;
const STATUS_CLOSED_RESOLVED = 1; const STATUS_CLOSED_RESOLVED = 1;

View file

@ -6,6 +6,8 @@
phutil_require_module('phabricator', 'applications/maniphest/constants/base');
phutil_require_module('phutil', 'utils'); phutil_require_module('phutil', 'utils');

View file

@ -16,7 +16,10 @@
* limitations under the License. * limitations under the License.
*/ */
final class ManiphestTransactionType { /**
* @group maniphest
*/
final class ManiphestTransactionType extends ManiphestConstants {
const TYPE_NONE = 'comment'; const TYPE_NONE = 'comment';
const TYPE_STATUS = 'status'; const TYPE_STATUS = 'status';

View file

@ -6,5 +6,7 @@
phutil_require_module('phabricator', 'applications/maniphest/constants/base');
phutil_require_source('ManiphestTransactionType.php'); phutil_require_source('ManiphestTransactionType.php');

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
abstract class ManiphestController extends PhabricatorController { abstract class ManiphestController extends PhabricatorController {
public function buildStandardPageResponse($view, array $data) { public function buildStandardPageResponse($view, array $data) {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
class ManiphestTaskDescriptionChangeController extends ManiphestController { class ManiphestTaskDescriptionChangeController extends ManiphestController {
private $transactionID; private $transactionID;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
class ManiphestTaskDetailController extends ManiphestController { class ManiphestTaskDetailController extends ManiphestController {
private $id; private $id;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
class ManiphestTaskEditController extends ManiphestController { class ManiphestTaskEditController extends ManiphestController {
private $id; private $id;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
class ManiphestTaskListController extends ManiphestController { class ManiphestTaskListController extends ManiphestController {
const DEFAULT_PAGE_SIZE = 1000; const DEFAULT_PAGE_SIZE = 1000;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
class ManiphestTransactionPreviewController extends ManiphestController { class ManiphestTransactionPreviewController extends ManiphestController {
private $id; private $id;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
class ManiphestTransactionSaveController extends ManiphestController { class ManiphestTransactionSaveController extends ManiphestController {
public function processRequest() { public function processRequest() {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
class ManiphestTransactionEditor { class ManiphestTransactionEditor {
private $parentMessageID; private $parentMessageID;

View file

@ -19,6 +19,8 @@
/** /**
* Query tasks by specific criteria. This class uses the higher-performance * Query tasks by specific criteria. This class uses the higher-performance
* but less-general Maniphest indexes to satisfy queries. * but less-general Maniphest indexes to satisfy queries.
*
* @group maniphest
*/ */
final class ManiphestTaskQuery { final class ManiphestTaskQuery {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
class ManiphestReplyHandler extends PhabricatorMailReplyHandler { class ManiphestReplyHandler extends PhabricatorMailReplyHandler {
public function validateMailReceiver($mail_receiver) { public function validateMailReceiver($mail_receiver) {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
class ManiphestDAO extends PhabricatorLiskDAO { class ManiphestDAO extends PhabricatorLiskDAO {
public function getApplicationName() { public function getApplicationName() {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
class ManiphestTask extends ManiphestDAO { class ManiphestTask extends ManiphestDAO {
protected $phid; protected $phid;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group maniphest
*/
class ManiphestTransaction extends ManiphestDAO { class ManiphestTransaction extends ManiphestDAO {
protected $taskID; protected $taskID;

View file

@ -0,0 +1,24 @@
<?php
/*
* Copyright 2011 Facebook, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @group maniphest
*/
abstract class ManiphestView extends AphrontView {
}

View file

@ -0,0 +1,12 @@
<?php
/**
* This file is automatically generated. Lint this module to rebuild it.
* @generated
*/
phutil_require_module('phabricator', 'view/base');
phutil_require_source('ManiphestView.php');

View file

@ -16,7 +16,10 @@
* limitations under the License. * limitations under the License.
*/ */
class ManiphestTaskListView extends AphrontView { /**
* @group maniphest
*/
class ManiphestTaskListView extends ManiphestView {
private $tasks; private $tasks;
private $handles; private $handles;

View file

@ -6,8 +6,8 @@
phutil_require_module('phabricator', 'applications/maniphest/view/base');
phutil_require_module('phabricator', 'applications/maniphest/view/tasksummary'); phutil_require_module('phabricator', 'applications/maniphest/view/tasksummary');
phutil_require_module('phabricator', 'view/base');
phutil_require_source('ManiphestTaskListView.php'); phutil_require_source('ManiphestTaskListView.php');

View file

@ -16,7 +16,10 @@
* limitations under the License. * limitations under the License.
*/ */
class ManiphestTaskSummaryView extends AphrontView { /**
* @group maniphest
*/
class ManiphestTaskSummaryView extends ManiphestView {
private $task; private $task;
private $handles; private $handles;

View file

@ -8,8 +8,8 @@
phutil_require_module('phabricator', 'applications/maniphest/constants/priority'); phutil_require_module('phabricator', 'applications/maniphest/constants/priority');
phutil_require_module('phabricator', 'applications/maniphest/constants/status'); phutil_require_module('phabricator', 'applications/maniphest/constants/status');
phutil_require_module('phabricator', 'applications/maniphest/view/base');
phutil_require_module('phabricator', 'infrastructure/celerity/api'); phutil_require_module('phabricator', 'infrastructure/celerity/api');
phutil_require_module('phabricator', 'view/base');
phutil_require_module('phabricator', 'view/utils'); phutil_require_module('phabricator', 'view/utils');
phutil_require_module('phutil', 'markup'); phutil_require_module('phutil', 'markup');

View file

@ -16,7 +16,10 @@
* limitations under the License. * limitations under the License.
*/ */
class ManiphestTransactionDetailView extends AphrontView { /**
* @group maniphest
*/
class ManiphestTransactionDetailView extends ManiphestView {
private $transactions; private $transactions;
private $handles; private $handles;

View file

@ -9,12 +9,12 @@
phutil_require_module('phabricator', 'applications/maniphest/constants/priority'); phutil_require_module('phabricator', 'applications/maniphest/constants/priority');
phutil_require_module('phabricator', 'applications/maniphest/constants/status'); phutil_require_module('phabricator', 'applications/maniphest/constants/status');
phutil_require_module('phabricator', 'applications/maniphest/constants/transactiontype'); phutil_require_module('phabricator', 'applications/maniphest/constants/transactiontype');
phutil_require_module('phabricator', 'applications/maniphest/view/base');
phutil_require_module('phabricator', 'applications/phid/constants'); phutil_require_module('phabricator', 'applications/phid/constants');
phutil_require_module('phabricator', 'infrastructure/celerity/api'); phutil_require_module('phabricator', 'infrastructure/celerity/api');
phutil_require_module('phabricator', 'infrastructure/env'); phutil_require_module('phabricator', 'infrastructure/env');
phutil_require_module('phabricator', 'infrastructure/javelin/api'); phutil_require_module('phabricator', 'infrastructure/javelin/api');
phutil_require_module('phabricator', 'infrastructure/javelin/markup'); phutil_require_module('phabricator', 'infrastructure/javelin/markup');
phutil_require_module('phabricator', 'view/base');
phutil_require_module('phabricator', 'view/utils'); phutil_require_module('phabricator', 'view/utils');
phutil_require_module('phutil', 'markup'); phutil_require_module('phutil', 'markup');

View file

@ -16,7 +16,10 @@
* limitations under the License. * limitations under the License.
*/ */
class ManiphestTransactionListView extends AphrontView { /**
* @group maniphest
*/
class ManiphestTransactionListView extends ManiphestView {
private $transactions; private $transactions;
private $handles; private $handles;

View file

@ -6,8 +6,8 @@
phutil_require_module('phabricator', 'applications/maniphest/view/base');
phutil_require_module('phabricator', 'applications/maniphest/view/transactiondetail'); phutil_require_module('phabricator', 'applications/maniphest/view/transactiondetail');
phutil_require_module('phabricator', 'view/base');
phutil_require_source('ManiphestTransactionListView.php'); phutil_require_source('ManiphestTransactionListView.php');

View file

@ -1,7 +1,7 @@
@title Remarkup Reference @title Remarkup Reference
@group userguide @group userguide
Explains how to make bold text, etc. This makes your words louder so you can win Explains how to make bold text; this makes your words louder so you can win
arguments. arguments.
= Overview = = Overview =