Some documentation updates.

2024-12-22 21:40:55 +01:00 · 2011-09-14 08:02:31 -07:00 · 2011-09-14 08:02:31 -07:00 · 4bec2579d5
commit 4bec2579d5
parent 1620bce842
59 changed files with 174 additions and 4 deletions
--- a/.divinerconfig
+++ b/.divinerconfig
@ -11,13 +11,17 @@
    "differential" : "Differential (Code Review)",
    "diffusion" : "Diffusion (Repository Browser)",
    "maniphest" : "Maniphest (Task Tracking)",
+    "slowvote" : "Slowvote (Polls)",
    "herald" : "Herald (Notifications)",
    "conduit" : "Conduit (Phabricator HTTP API)",
    "celerity" : "Celerity (CSS/JS Management)",
+    "phriction" : "Phriction (Wiki)",
    "aphront" : "Aphront (Web Stack)",
    "console" : "DarkConsole (Debugging Console)",
    "storage" : "Storage",
    "filestorage" : "File Storage",
+    "search" : "Search",
+    "daemon" : "Daemons, Tasks and Workers",
    "irc" : "IRC",
    "markup" : "Remarkup Extensions"
  },
--- a/src/aphront/console/api/DarkConsole.php
+++ b/src/aphront/console/api/DarkConsole.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group console
+ */
 class DarkConsole {

 }
--- a/src/aphront/console/controller/DarkConsoleController.php
+++ b/src/aphront/console/controller/DarkConsoleController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group console
+ */
 class DarkConsoleController extends PhabricatorController {

  protected $op;
--- a/src/aphront/console/core/DarkConsoleCore.php
+++ b/src/aphront/console/core/DarkConsoleCore.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group console
+ */
 final class DarkConsoleCore {

  const PLUGIN_ERRORLOG     = 'ErrorLog';
@ -57,7 +60,6 @@ final class DarkConsoleCore {

  public static function newPlugin($plugin) {
    $class = 'DarkConsole'.$plugin.'Plugin';
-    PhutilSymbolLoader::loadClass($class);
    return newv($class, array());
  }

--- a/src/aphront/console/plugin/base/DarkConsolePlugin.php
+++ b/src/aphront/console/plugin/base/DarkConsolePlugin.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group console
+ */
 abstract class DarkConsolePlugin {

  private $data;
--- a/src/aphront/console/plugin/config/DarkConsoleConfigPlugin.php
+++ b/src/aphront/console/plugin/config/DarkConsoleConfigPlugin.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group console
+ */
 class DarkConsoleConfigPlugin extends DarkConsolePlugin {

  public function getName() {
--- a/src/aphront/console/plugin/errorlog/DarkConsoleErrorLogPlugin.php
+++ b/src/aphront/console/plugin/errorlog/DarkConsoleErrorLogPlugin.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group console
+ */
 class DarkConsoleErrorLogPlugin extends DarkConsolePlugin {

  public function getName() {
--- a/src/aphront/console/plugin/errorlog/api/DarkConsoleErrorLogPluginAPI.php
+++ b/src/aphront/console/plugin/errorlog/api/DarkConsoleErrorLogPluginAPI.php
@ -16,7 +16,9 @@
 * limitations under the License.
 */

-
+/**
+ * @group console
+ */
 class DarkConsoleErrorLogPluginAPI {

  private static $errors = array();
--- a/src/aphront/console/plugin/request/DarkConsoleRequestPlugin.php
+++ b/src/aphront/console/plugin/request/DarkConsoleRequestPlugin.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group console
+ */
 class DarkConsoleRequestPlugin extends DarkConsolePlugin {

  public function getName() {
--- a/src/aphront/console/plugin/services/DarkConsoleServicesPlugin.php
+++ b/src/aphront/console/plugin/services/DarkConsoleServicesPlugin.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group console
+ */
 class DarkConsoleServicesPlugin extends DarkConsolePlugin {

  protected $observations;
--- a/src/aphront/console/plugin/xhprof/DarkConsoleXHProfPlugin.php
+++ b/src/aphront/console/plugin/xhprof/DarkConsoleXHProfPlugin.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group console
+ */
 class DarkConsoleXHProfPlugin extends DarkConsolePlugin {

  protected $xhprofID;
--- a/src/aphront/console/plugin/xhprof/api/DarkConsoleXHProfPluginAPI.php
+++ b/src/aphront/console/plugin/xhprof/api/DarkConsoleXHProfPluginAPI.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group console
+ */
 final class DarkConsoleXHProfPluginAPI {

  private static $profilerStarted;
--- a/src/applications/phriction/constants/action/PhrictionActionConstants.php
+++ b/src/applications/phriction/constants/action/PhrictionActionConstants.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 class PhrictionActionConstants extends PhrictionConstants {

  const ACTION_CREATE   = 'create';
--- a/src/applications/phriction/constants/base/PhrictionConstants.php
+++ b/src/applications/phriction/constants/base/PhrictionConstants.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 abstract class PhrictionConstants {

 }
--- a/src/applications/phriction/controller/base/PhrictionController.php
+++ b/src/applications/phriction/controller/base/PhrictionController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 abstract class PhrictionController extends PhabricatorController {

  public function buildStandardPageResponse($view, array $data) {
--- a/src/applications/phriction/controller/diff/PhrictionDiffController.php
+++ b/src/applications/phriction/controller/diff/PhrictionDiffController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 class PhrictionDiffController
  extends PhrictionController {

--- a/src/applications/phriction/controller/document/PhrictionDocumentController.php
+++ b/src/applications/phriction/controller/document/PhrictionDocumentController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 class PhrictionDocumentController
  extends PhrictionController {

--- a/src/applications/phriction/controller/documentpreview/PhrictionDocumentPreviewController.php
+++ b/src/applications/phriction/controller/documentpreview/PhrictionDocumentPreviewController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 class PhrictionDocumentPreviewController
  extends PhrictionController {

--- a/src/applications/phriction/controller/edit/PhrictionEditController.php
+++ b/src/applications/phriction/controller/edit/PhrictionEditController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 class PhrictionEditController
  extends PhrictionController {

--- a/src/applications/phriction/controller/history/PhrictionHistoryController.php
+++ b/src/applications/phriction/controller/history/PhrictionHistoryController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 class PhrictionHistoryController
  extends PhrictionController {

--- a/src/applications/phriction/controller/list/PhrictionListController.php
+++ b/src/applications/phriction/controller/list/PhrictionListController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 class PhrictionListController
  extends PhrictionController {

--- a/src/applications/phriction/editor/document/PhrictionDocumentEditor.php
+++ b/src/applications/phriction/editor/document/PhrictionDocumentEditor.php
@ -18,6 +18,8 @@

 /**
 * Create or update Phriction documents.
+ *
+ * @group phriction
 */
 final class PhrictionDocumentEditor {

--- a/src/applications/phriction/storage/base/PhrictionDAO.php
+++ b/src/applications/phriction/storage/base/PhrictionDAO.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 abstract class PhrictionDAO extends PhabricatorLiskDAO {

  public function getApplicationName() {
--- a/src/applications/phriction/storage/content/PhrictionContent.php
+++ b/src/applications/phriction/storage/content/PhrictionContent.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 class PhrictionContent extends PhrictionDAO {

  protected $id;
--- a/src/applications/phriction/storage/document/PhrictionDocument.php
+++ b/src/applications/phriction/storage/document/PhrictionDocument.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group phriction
+ */
 class PhrictionDocument extends PhrictionDAO {

  protected $id;
--- a/src/applications/phriction/storage/document/tests/PhrictionDocumentTestCase.php
+++ b/src/applications/phriction/storage/document/tests/PhrictionDocumentTestCase.php
@ -17,7 +17,7 @@
 */

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

--- a/src/applications/search/constants/field/PhabricatorSearchField.php
+++ b/src/applications/search/constants/field/PhabricatorSearchField.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 final class PhabricatorSearchField {

  const FIELD_TITLE         = 'titl';
--- a/src/applications/search/constants/relationship/PhabricatorSearchRelationship.php
+++ b/src/applications/search/constants/relationship/PhabricatorSearchRelationship.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 final class PhabricatorSearchRelationship {

  const RELATIONSHIP_AUTHOR     = 'auth';
--- a/src/applications/search/controller/attach/PhabricatorSearchAttachController.php
+++ b/src/applications/search/controller/attach/PhabricatorSearchAttachController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchAttachController extends PhabricatorSearchController {

  private $phid;
--- a/src/applications/search/controller/base/PhabricatorSearchBaseController.php
+++ b/src/applications/search/controller/base/PhabricatorSearchBaseController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 abstract class PhabricatorSearchBaseController extends PhabricatorController {

  public function buildStandardPageResponse($view, array $data) {
--- a/src/applications/search/controller/index/PhabricatorSearchIndexController.php
+++ b/src/applications/search/controller/index/PhabricatorSearchIndexController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchIndexController extends PhabricatorSearchBaseController {

  private $phid;
--- a/src/applications/search/controller/search/PhabricatorSearchController.php
+++ b/src/applications/search/controller/search/PhabricatorSearchController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchController extends PhabricatorSearchBaseController {

  private $id;
--- a/src/applications/search/controller/select/PhabricatorSearchSelectController.php
+++ b/src/applications/search/controller/select/PhabricatorSearchSelectController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchSelectController
  extends PhabricatorSearchController {

--- a/src/applications/search/engine/mysql/PhabricatorSearchEngineMySQL.php
+++ b/src/applications/search/engine/mysql/PhabricatorSearchEngineMySQL.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 final class PhabricatorSearchEngineMySQL extends PhabricatorSearchEngine {

  public function reindexAbstractDocument(
--- a/src/applications/search/index/abstractdocument/PhabricatorSearchAbstractDocument.php
+++ b/src/applications/search/index/abstractdocument/PhabricatorSearchAbstractDocument.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 final class PhabricatorSearchAbstractDocument {

  private $phid;
--- a/src/applications/search/index/indexer/base/PhabricatorSearchDocumentIndexer.php
+++ b/src/applications/search/index/indexer/base/PhabricatorSearchDocumentIndexer.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 abstract class PhabricatorSearchDocumentIndexer {

  // TODO: Make this whole class tree concrete?
--- a/src/applications/search/index/indexer/differential/PhabricatorSearchDifferentialIndexer.php
+++ b/src/applications/search/index/indexer/differential/PhabricatorSearchDifferentialIndexer.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchDifferentialIndexer
  extends PhabricatorSearchDocumentIndexer {

--- a/src/applications/search/index/indexer/maniphest/PhabricatorSearchManiphestIndexer.php
+++ b/src/applications/search/index/indexer/maniphest/PhabricatorSearchManiphestIndexer.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchManiphestIndexer
  extends PhabricatorSearchDocumentIndexer {

--- a/src/applications/search/index/indexer/phriction/PhabricatorSearchPhrictionIndexer.php
+++ b/src/applications/search/index/indexer/phriction/PhabricatorSearchPhrictionIndexer.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchPhrictionIndexer
  extends PhabricatorSearchDocumentIndexer {

--- a/src/applications/search/index/indexer/repository/PhabricatorSearchCommitIndexer.php
+++ b/src/applications/search/index/indexer/repository/PhabricatorSearchCommitIndexer.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchCommitIndexer
  extends PhabricatorSearchDocumentIndexer {

--- a/src/applications/search/index/indexer/user/PhabricatorSearchUserIndexer.php
+++ b/src/applications/search/index/indexer/user/PhabricatorSearchUserIndexer.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchUserIndexer
  extends PhabricatorSearchDocumentIndexer {

--- a/src/applications/search/selector/base/PhabricatorSearchEngineSelector.php
+++ b/src/applications/search/selector/base/PhabricatorSearchEngineSelector.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 abstract class PhabricatorSearchEngineSelector {

  final public function __construct() {
--- a/src/applications/search/selector/default/PhabricatorDefaultSearchEngineSelector.php
+++ b/src/applications/search/selector/default/PhabricatorDefaultSearchEngineSelector.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 final class PhabricatorDefaultSearchEngineSelector
  extends PhabricatorSearchEngineSelector {

--- a/src/applications/search/storage/base/PhabricatorSearchDAO.php
+++ b/src/applications/search/storage/base/PhabricatorSearchDAO.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 abstract class PhabricatorSearchDAO extends PhabricatorLiskDAO {

  public function getApplicationName() {
--- a/src/applications/search/storage/document/document/PhabricatorSearchDocument.php
+++ b/src/applications/search/storage/document/document/PhabricatorSearchDocument.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchDocument extends PhabricatorSearchDAO {

  protected $phid;
--- a/src/applications/search/storage/document/field/PhabricatorSearchDocumentField.php
+++ b/src/applications/search/storage/document/field/PhabricatorSearchDocumentField.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchDocumentField extends PhabricatorSearchDAO {

  protected $phid;
--- a/src/applications/search/storage/document/relationship/PhabricatorSearchDocumentRelationship.php
+++ b/src/applications/search/storage/document/relationship/PhabricatorSearchDocumentRelationship.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchDocumentRelationship extends PhabricatorSearchDAO {

  protected $phid;
--- a/src/applications/search/storage/query/PhabricatorSearchQuery.php
+++ b/src/applications/search/storage/query/PhabricatorSearchQuery.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 class PhabricatorSearchQuery extends PhabricatorSearchDAO {

  protected $authorPHID;
--- a/src/applications/search/view/searchresult/PhabricatorSearchResultView.php
+++ b/src/applications/search/view/searchresult/PhabricatorSearchResultView.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group search
+ */
 final class PhabricatorSearchResultView extends AphrontView {

  private $handle;
--- a/src/applications/slowvote/controller/base/PhabricatorSlowvoteController.php
+++ b/src/applications/slowvote/controller/base/PhabricatorSlowvoteController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group slowvote
+ */
 abstract class PhabricatorSlowvoteController extends PhabricatorController {

  public function buildStandardPageResponse($view, array $data) {
--- a/src/applications/slowvote/controller/create/PhabricatorSlowvoteCreateController.php
+++ b/src/applications/slowvote/controller/create/PhabricatorSlowvoteCreateController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group slowvote
+ */
 class PhabricatorSlowvoteCreateController
  extends PhabricatorSlowvoteController {

--- a/src/applications/slowvote/controller/list/PhabricatorSlowvoteListController.php
+++ b/src/applications/slowvote/controller/list/PhabricatorSlowvoteListController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group slowvote
+ */
 class PhabricatorSlowvoteListController
  extends PhabricatorSlowvoteController {

--- a/src/applications/slowvote/controller/poll/PhabricatorSlowvotePollController.php
+++ b/src/applications/slowvote/controller/poll/PhabricatorSlowvotePollController.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group slowvote
+ */
 class PhabricatorSlowvotePollController
  extends PhabricatorSlowvoteController {

--- a/src/applications/slowvote/storage/base/PhabricatorSlowvoteDAO.php
+++ b/src/applications/slowvote/storage/base/PhabricatorSlowvoteDAO.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group slowvote
+ */
 class PhabricatorSlowvoteDAO extends PhabricatorLiskDAO {

  public function getApplicationName() {
--- a/src/applications/slowvote/storage/choice/PhabricatorSlowvoteChoice.php
+++ b/src/applications/slowvote/storage/choice/PhabricatorSlowvoteChoice.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group slowvote
+ */
 class PhabricatorSlowvoteChoice extends PhabricatorSlowvoteDAO {

  protected $pollID;
--- a/src/applications/slowvote/storage/comment/PhabricatorSlowvoteComment.php
+++ b/src/applications/slowvote/storage/comment/PhabricatorSlowvoteComment.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group slowvote
+ */
 class PhabricatorSlowvoteComment extends PhabricatorSlowvoteDAO {

  protected $pollID;
--- a/src/applications/slowvote/storage/option/PhabricatorSlowvoteOption.php
+++ b/src/applications/slowvote/storage/option/PhabricatorSlowvoteOption.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group slowvote
+ */
 class PhabricatorSlowvoteOption extends PhabricatorSlowvoteDAO {

  protected $pollID;
--- a/src/applications/slowvote/storage/poll/PhabricatorSlowvotePoll.php
+++ b/src/applications/slowvote/storage/poll/PhabricatorSlowvotePoll.php
@ -16,6 +16,9 @@
 * limitations under the License.
 */

+/**
+ * @group slowvote
+ */
 class PhabricatorSlowvotePoll extends PhabricatorSlowvoteDAO {

  const RESPONSES_VISIBLE = 0;
--- a/src/docs/roadmap.diviner
+++ b/src/docs/roadmap.diviner
@ -2,7 +2,7 @@
@group intro

 Insight into the direction and progress of Phabricator. This document was last
-updated **July 22, 2011**.
+updated **September 14th, 2011**.

 = Status =

@ -14,6 +14,7 @@ active development.
 The current focus on Phabricator is primarily feature buildout, particularly in
 these applications:

+  - **Mercurial**: Mercurial support is actively landing.
  - **Maniphest**: A lot of early adopters are getting into the suite because
    of this tool, and we're continuing to improve it.
  - **Phriction**: We just landed a wiki application, which basically works but