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

Some documentation updates.

This commit is contained in:
epriestley 2011-09-14 08:02:31 -07:00
parent 1620bce842
commit 4bec2579d5
59 changed files with 174 additions and 4 deletions

View file

@ -11,13 +11,17 @@
"differential" : "Differential (Code Review)", "differential" : "Differential (Code Review)",
"diffusion" : "Diffusion (Repository Browser)", "diffusion" : "Diffusion (Repository Browser)",
"maniphest" : "Maniphest (Task Tracking)", "maniphest" : "Maniphest (Task Tracking)",
"slowvote" : "Slowvote (Polls)",
"herald" : "Herald (Notifications)", "herald" : "Herald (Notifications)",
"conduit" : "Conduit (Phabricator HTTP API)", "conduit" : "Conduit (Phabricator HTTP API)",
"celerity" : "Celerity (CSS/JS Management)", "celerity" : "Celerity (CSS/JS Management)",
"phriction" : "Phriction (Wiki)",
"aphront" : "Aphront (Web Stack)", "aphront" : "Aphront (Web Stack)",
"console" : "DarkConsole (Debugging Console)", "console" : "DarkConsole (Debugging Console)",
"storage" : "Storage", "storage" : "Storage",
"filestorage" : "File Storage", "filestorage" : "File Storage",
"search" : "Search",
"daemon" : "Daemons, Tasks and Workers",
"irc" : "IRC", "irc" : "IRC",
"markup" : "Remarkup Extensions" "markup" : "Remarkup Extensions"
}, },

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group console
*/
class DarkConsole { class DarkConsole {
} }

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group console
*/
class DarkConsoleController extends PhabricatorController { class DarkConsoleController extends PhabricatorController {
protected $op; protected $op;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group console
*/
final class DarkConsoleCore { final class DarkConsoleCore {
const PLUGIN_ERRORLOG = 'ErrorLog'; const PLUGIN_ERRORLOG = 'ErrorLog';
@ -57,7 +60,6 @@ final class DarkConsoleCore {
public static function newPlugin($plugin) { public static function newPlugin($plugin) {
$class = 'DarkConsole'.$plugin.'Plugin'; $class = 'DarkConsole'.$plugin.'Plugin';
PhutilSymbolLoader::loadClass($class);
return newv($class, array()); return newv($class, array());
} }

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group console
*/
abstract class DarkConsolePlugin { abstract class DarkConsolePlugin {
private $data; private $data;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group console
*/
class DarkConsoleConfigPlugin extends DarkConsolePlugin { class DarkConsoleConfigPlugin extends DarkConsolePlugin {
public function getName() { public function getName() {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group console
*/
class DarkConsoleErrorLogPlugin extends DarkConsolePlugin { class DarkConsoleErrorLogPlugin extends DarkConsolePlugin {
public function getName() { public function getName() {

View file

@ -16,7 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group console
*/
class DarkConsoleErrorLogPluginAPI { class DarkConsoleErrorLogPluginAPI {
private static $errors = array(); private static $errors = array();

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group console
*/
class DarkConsoleRequestPlugin extends DarkConsolePlugin { class DarkConsoleRequestPlugin extends DarkConsolePlugin {
public function getName() { public function getName() {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group console
*/
class DarkConsoleServicesPlugin extends DarkConsolePlugin { class DarkConsoleServicesPlugin extends DarkConsolePlugin {
protected $observations; protected $observations;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group console
*/
class DarkConsoleXHProfPlugin extends DarkConsolePlugin { class DarkConsoleXHProfPlugin extends DarkConsolePlugin {
protected $xhprofID; protected $xhprofID;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group console
*/
final class DarkConsoleXHProfPluginAPI { final class DarkConsoleXHProfPluginAPI {
private static $profilerStarted; private static $profilerStarted;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group phriction
*/
class PhrictionActionConstants extends PhrictionConstants { class PhrictionActionConstants extends PhrictionConstants {
const ACTION_CREATE = 'create'; const ACTION_CREATE = 'create';

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group phriction
*/
abstract class PhrictionConstants { abstract class PhrictionConstants {
} }

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group phriction
*/
abstract class PhrictionController extends PhabricatorController { abstract class PhrictionController 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 phriction
*/
class PhrictionDiffController class PhrictionDiffController
extends PhrictionController { extends PhrictionController {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group phriction
*/
class PhrictionDocumentController class PhrictionDocumentController
extends PhrictionController { extends PhrictionController {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group phriction
*/
class PhrictionDocumentPreviewController class PhrictionDocumentPreviewController
extends PhrictionController { extends PhrictionController {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group phriction
*/
class PhrictionEditController class PhrictionEditController
extends PhrictionController { extends PhrictionController {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group phriction
*/
class PhrictionHistoryController class PhrictionHistoryController
extends PhrictionController { extends PhrictionController {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group phriction
*/
class PhrictionListController class PhrictionListController
extends PhrictionController { extends PhrictionController {

View file

@ -18,6 +18,8 @@
/** /**
* Create or update Phriction documents. * Create or update Phriction documents.
*
* @group phriction
*/ */
final class PhrictionDocumentEditor { final class PhrictionDocumentEditor {

View file

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

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group phriction
*/
class PhrictionContent extends PhrictionDAO { class PhrictionContent extends PhrictionDAO {
protected $id; protected $id;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group phriction
*/
class PhrictionDocument extends PhrictionDAO { class PhrictionDocument extends PhrictionDAO {
protected $id; protected $id;

View file

@ -17,7 +17,7 @@
*/ */
/** /**
* @group markup * @group phriction
*/ */
class PhrictionDocumentTestCase extends PhabricatorTestCase { class PhrictionDocumentTestCase extends PhabricatorTestCase {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
final class PhabricatorSearchField { final class PhabricatorSearchField {
const FIELD_TITLE = 'titl'; const FIELD_TITLE = 'titl';

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
final class PhabricatorSearchRelationship { final class PhabricatorSearchRelationship {
const RELATIONSHIP_AUTHOR = 'auth'; const RELATIONSHIP_AUTHOR = 'auth';

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchAttachController extends PhabricatorSearchController { class PhabricatorSearchAttachController extends PhabricatorSearchController {
private $phid; private $phid;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
abstract class PhabricatorSearchBaseController extends PhabricatorController { abstract class PhabricatorSearchBaseController 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 search
*/
class PhabricatorSearchIndexController extends PhabricatorSearchBaseController { class PhabricatorSearchIndexController extends PhabricatorSearchBaseController {
private $phid; private $phid;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchController extends PhabricatorSearchBaseController { class PhabricatorSearchController extends PhabricatorSearchBaseController {
private $id; private $id;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchSelectController class PhabricatorSearchSelectController
extends PhabricatorSearchController { extends PhabricatorSearchController {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
final class PhabricatorSearchEngineMySQL extends PhabricatorSearchEngine { final class PhabricatorSearchEngineMySQL extends PhabricatorSearchEngine {
public function reindexAbstractDocument( public function reindexAbstractDocument(

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
final class PhabricatorSearchAbstractDocument { final class PhabricatorSearchAbstractDocument {
private $phid; private $phid;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
abstract class PhabricatorSearchDocumentIndexer { abstract class PhabricatorSearchDocumentIndexer {
// TODO: Make this whole class tree concrete? // TODO: Make this whole class tree concrete?

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchDifferentialIndexer class PhabricatorSearchDifferentialIndexer
extends PhabricatorSearchDocumentIndexer { extends PhabricatorSearchDocumentIndexer {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchManiphestIndexer class PhabricatorSearchManiphestIndexer
extends PhabricatorSearchDocumentIndexer { extends PhabricatorSearchDocumentIndexer {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchPhrictionIndexer class PhabricatorSearchPhrictionIndexer
extends PhabricatorSearchDocumentIndexer { extends PhabricatorSearchDocumentIndexer {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchCommitIndexer class PhabricatorSearchCommitIndexer
extends PhabricatorSearchDocumentIndexer { extends PhabricatorSearchDocumentIndexer {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchUserIndexer class PhabricatorSearchUserIndexer
extends PhabricatorSearchDocumentIndexer { extends PhabricatorSearchDocumentIndexer {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
abstract class PhabricatorSearchEngineSelector { abstract class PhabricatorSearchEngineSelector {
final public function __construct() { final public function __construct() {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
final class PhabricatorDefaultSearchEngineSelector final class PhabricatorDefaultSearchEngineSelector
extends PhabricatorSearchEngineSelector { extends PhabricatorSearchEngineSelector {

View file

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

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchDocument extends PhabricatorSearchDAO { class PhabricatorSearchDocument extends PhabricatorSearchDAO {
protected $phid; protected $phid;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchDocumentField extends PhabricatorSearchDAO { class PhabricatorSearchDocumentField extends PhabricatorSearchDAO {
protected $phid; protected $phid;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchDocumentRelationship extends PhabricatorSearchDAO { class PhabricatorSearchDocumentRelationship extends PhabricatorSearchDAO {
protected $phid; protected $phid;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
class PhabricatorSearchQuery extends PhabricatorSearchDAO { class PhabricatorSearchQuery extends PhabricatorSearchDAO {
protected $authorPHID; protected $authorPHID;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group search
*/
final class PhabricatorSearchResultView extends AphrontView { final class PhabricatorSearchResultView extends AphrontView {
private $handle; private $handle;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group slowvote
*/
abstract class PhabricatorSlowvoteController extends PhabricatorController { abstract class PhabricatorSlowvoteController 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 slowvote
*/
class PhabricatorSlowvoteCreateController class PhabricatorSlowvoteCreateController
extends PhabricatorSlowvoteController { extends PhabricatorSlowvoteController {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group slowvote
*/
class PhabricatorSlowvoteListController class PhabricatorSlowvoteListController
extends PhabricatorSlowvoteController { extends PhabricatorSlowvoteController {

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group slowvote
*/
class PhabricatorSlowvotePollController class PhabricatorSlowvotePollController
extends PhabricatorSlowvoteController { extends PhabricatorSlowvoteController {

View file

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

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group slowvote
*/
class PhabricatorSlowvoteChoice extends PhabricatorSlowvoteDAO { class PhabricatorSlowvoteChoice extends PhabricatorSlowvoteDAO {
protected $pollID; protected $pollID;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group slowvote
*/
class PhabricatorSlowvoteComment extends PhabricatorSlowvoteDAO { class PhabricatorSlowvoteComment extends PhabricatorSlowvoteDAO {
protected $pollID; protected $pollID;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group slowvote
*/
class PhabricatorSlowvoteOption extends PhabricatorSlowvoteDAO { class PhabricatorSlowvoteOption extends PhabricatorSlowvoteDAO {
protected $pollID; protected $pollID;

View file

@ -16,6 +16,9 @@
* limitations under the License. * limitations under the License.
*/ */
/**
* @group slowvote
*/
class PhabricatorSlowvotePoll extends PhabricatorSlowvoteDAO { class PhabricatorSlowvotePoll extends PhabricatorSlowvoteDAO {
const RESPONSES_VISIBLE = 0; const RESPONSES_VISIBLE = 0;

View file

@ -2,7 +2,7 @@
@group intro @group intro
Insight into the direction and progress of Phabricator. This document was last Insight into the direction and progress of Phabricator. This document was last
updated **July 22, 2011**. updated **September 14th, 2011**.
= Status = = Status =
@ -14,6 +14,7 @@ active development.
The current focus on Phabricator is primarily feature buildout, particularly in The current focus on Phabricator is primarily feature buildout, particularly in
these applications: these applications:
- **Mercurial**: Mercurial support is actively landing.
- **Maniphest**: A lot of early adopters are getting into the suite because - **Maniphest**: A lot of early adopters are getting into the suite because
of this tool, and we're continuing to improve it. of this tool, and we're continuing to improve it.
- **Phriction**: We just landed a wiki application, which basically works but - **Phriction**: We just landed a wiki application, which basically works but