Skip to content
Browse files

Some documentation updates.

  • Loading branch information...
1 parent 1620bce commit 4bec2579d5dffba4a9ad64d2da7dd8237c5740cb @epriestley epriestley committed
Showing with 174 additions and 4 deletions.
  1. +4 −0 .divinerconfig
  2. +3 −0 src/aphront/console/api/DarkConsole.php
  3. +3 −0 src/aphront/console/controller/DarkConsoleController.php
  4. +3 −1 src/aphront/console/core/DarkConsoleCore.php
  5. +3 −0 src/aphront/console/plugin/base/DarkConsolePlugin.php
  6. +3 −0 src/aphront/console/plugin/config/DarkConsoleConfigPlugin.php
  7. +3 −0 src/aphront/console/plugin/errorlog/DarkConsoleErrorLogPlugin.php
  8. +3 −1 src/aphront/console/plugin/errorlog/api/DarkConsoleErrorLogPluginAPI.php
  9. +3 −0 src/aphront/console/plugin/request/DarkConsoleRequestPlugin.php
  10. +3 −0 src/aphront/console/plugin/services/DarkConsoleServicesPlugin.php
  11. +3 −0 src/aphront/console/plugin/xhprof/DarkConsoleXHProfPlugin.php
  12. +3 −0 src/aphront/console/plugin/xhprof/api/DarkConsoleXHProfPluginAPI.php
  13. +3 −0 src/applications/phriction/constants/action/PhrictionActionConstants.php
  14. +3 −0 src/applications/phriction/constants/base/PhrictionConstants.php
  15. +3 −0 src/applications/phriction/controller/base/PhrictionController.php
  16. +3 −0 src/applications/phriction/controller/diff/PhrictionDiffController.php
  17. +3 −0 src/applications/phriction/controller/document/PhrictionDocumentController.php
  18. +3 −0 src/applications/phriction/controller/documentpreview/PhrictionDocumentPreviewController.php
  19. +3 −0 src/applications/phriction/controller/edit/PhrictionEditController.php
  20. +3 −0 src/applications/phriction/controller/history/PhrictionHistoryController.php
  21. +3 −0 src/applications/phriction/controller/list/PhrictionListController.php
  22. +2 −0 src/applications/phriction/editor/document/PhrictionDocumentEditor.php
  23. +3 −0 src/applications/phriction/storage/base/PhrictionDAO.php
  24. +3 −0 src/applications/phriction/storage/content/PhrictionContent.php
  25. +3 −0 src/applications/phriction/storage/document/PhrictionDocument.php
  26. +1 −1 src/applications/phriction/storage/document/__tests__/PhrictionDocumentTestCase.php
  27. +3 −0 src/applications/search/constants/field/PhabricatorSearchField.php
  28. +3 −0 src/applications/search/constants/relationship/PhabricatorSearchRelationship.php
  29. +3 −0 src/applications/search/controller/attach/PhabricatorSearchAttachController.php
  30. +3 −0 src/applications/search/controller/base/PhabricatorSearchBaseController.php
  31. +3 −0 src/applications/search/controller/index/PhabricatorSearchIndexController.php
  32. +3 −0 src/applications/search/controller/search/PhabricatorSearchController.php
  33. +3 −0 src/applications/search/controller/select/PhabricatorSearchSelectController.php
  34. +3 −0 src/applications/search/engine/mysql/PhabricatorSearchEngineMySQL.php
  35. +3 −0 src/applications/search/index/abstractdocument/PhabricatorSearchAbstractDocument.php
  36. +3 −0 src/applications/search/index/indexer/base/PhabricatorSearchDocumentIndexer.php
  37. +3 −0 src/applications/search/index/indexer/differential/PhabricatorSearchDifferentialIndexer.php
  38. +3 −0 src/applications/search/index/indexer/maniphest/PhabricatorSearchManiphestIndexer.php
  39. +3 −0 src/applications/search/index/indexer/phriction/PhabricatorSearchPhrictionIndexer.php
  40. +3 −0 src/applications/search/index/indexer/repository/PhabricatorSearchCommitIndexer.php
  41. +3 −0 src/applications/search/index/indexer/user/PhabricatorSearchUserIndexer.php
  42. +3 −0 src/applications/search/selector/base/PhabricatorSearchEngineSelector.php
  43. +3 −0 src/applications/search/selector/default/PhabricatorDefaultSearchEngineSelector.php
  44. +3 −0 src/applications/search/storage/base/PhabricatorSearchDAO.php
  45. +3 −0 src/applications/search/storage/document/document/PhabricatorSearchDocument.php
  46. +3 −0 src/applications/search/storage/document/field/PhabricatorSearchDocumentField.php
  47. +3 −0 src/applications/search/storage/document/relationship/PhabricatorSearchDocumentRelationship.php
  48. +3 −0 src/applications/search/storage/query/PhabricatorSearchQuery.php
  49. +3 −0 src/applications/search/view/searchresult/PhabricatorSearchResultView.php
  50. +3 −0 src/applications/slowvote/controller/base/PhabricatorSlowvoteController.php
  51. +3 −0 src/applications/slowvote/controller/create/PhabricatorSlowvoteCreateController.php
  52. +3 −0 src/applications/slowvote/controller/list/PhabricatorSlowvoteListController.php
  53. +3 −0 src/applications/slowvote/controller/poll/PhabricatorSlowvotePollController.php
  54. +3 −0 src/applications/slowvote/storage/base/PhabricatorSlowvoteDAO.php
  55. +3 −0 src/applications/slowvote/storage/choice/PhabricatorSlowvoteChoice.php
  56. +3 −0 src/applications/slowvote/storage/comment/PhabricatorSlowvoteComment.php
  57. +3 −0 src/applications/slowvote/storage/option/PhabricatorSlowvoteOption.php
  58. +3 −0 src/applications/slowvote/storage/poll/PhabricatorSlowvotePoll.php
  59. +2 −1 src/docs/roadmap.diviner
View
4 .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"
},
View
3 src/aphront/console/api/DarkConsole.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group console
+ */
class DarkConsole {
}
View
3 src/aphront/console/controller/DarkConsoleController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group console
+ */
class DarkConsoleController extends PhabricatorController {
protected $op;
View
4 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 @@ public function __construct() {
public static function newPlugin($plugin) {
$class = 'DarkConsole'.$plugin.'Plugin';
- PhutilSymbolLoader::loadClass($class);
return newv($class, array());
}
View
3 src/aphront/console/plugin/base/DarkConsolePlugin.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group console
+ */
abstract class DarkConsolePlugin {
private $data;
View
3 src/aphront/console/plugin/config/DarkConsoleConfigPlugin.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group console
+ */
class DarkConsoleConfigPlugin extends DarkConsolePlugin {
public function getName() {
View
3 src/aphront/console/plugin/errorlog/DarkConsoleErrorLogPlugin.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group console
+ */
class DarkConsoleErrorLogPlugin extends DarkConsolePlugin {
public function getName() {
View
4 src/aphront/console/plugin/errorlog/api/DarkConsoleErrorLogPluginAPI.php
@@ -16,7 +16,9 @@
* limitations under the License.
*/
-
+/**
+ * @group console
+ */
class DarkConsoleErrorLogPluginAPI {
private static $errors = array();
View
3 src/aphront/console/plugin/request/DarkConsoleRequestPlugin.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group console
+ */
class DarkConsoleRequestPlugin extends DarkConsolePlugin {
public function getName() {
View
3 src/aphront/console/plugin/services/DarkConsoleServicesPlugin.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group console
+ */
class DarkConsoleServicesPlugin extends DarkConsolePlugin {
protected $observations;
View
3 src/aphront/console/plugin/xhprof/DarkConsoleXHProfPlugin.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group console
+ */
class DarkConsoleXHProfPlugin extends DarkConsolePlugin {
protected $xhprofID;
View
3 src/aphront/console/plugin/xhprof/api/DarkConsoleXHProfPluginAPI.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group console
+ */
final class DarkConsoleXHProfPluginAPI {
private static $profilerStarted;
View
3 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';
View
3 src/applications/phriction/constants/base/PhrictionConstants.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group phriction
+ */
abstract class PhrictionConstants {
}
View
3 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) {
View
3 src/applications/phriction/controller/diff/PhrictionDiffController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group phriction
+ */
class PhrictionDiffController
extends PhrictionController {
View
3 src/applications/phriction/controller/document/PhrictionDocumentController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group phriction
+ */
class PhrictionDocumentController
extends PhrictionController {
View
3 src/applications/phriction/controller/documentpreview/PhrictionDocumentPreviewController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group phriction
+ */
class PhrictionDocumentPreviewController
extends PhrictionController {
View
3 src/applications/phriction/controller/edit/PhrictionEditController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group phriction
+ */
class PhrictionEditController
extends PhrictionController {
View
3 src/applications/phriction/controller/history/PhrictionHistoryController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group phriction
+ */
class PhrictionHistoryController
extends PhrictionController {
View
3 src/applications/phriction/controller/list/PhrictionListController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group phriction
+ */
class PhrictionListController
extends PhrictionController {
View
2 src/applications/phriction/editor/document/PhrictionDocumentEditor.php
@@ -18,6 +18,8 @@
/**
* Create or update Phriction documents.
+ *
+ * @group phriction
*/
final class PhrictionDocumentEditor {
View
3 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() {
View
3 src/applications/phriction/storage/content/PhrictionContent.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group phriction
+ */
class PhrictionContent extends PhrictionDAO {
protected $id;
View
3 src/applications/phriction/storage/document/PhrictionDocument.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group phriction
+ */
class PhrictionDocument extends PhrictionDAO {
protected $id;
View
2 src/applications/phriction/storage/document/__tests__/PhrictionDocumentTestCase.php
@@ -17,7 +17,7 @@
*/
/**
- * @group markup
+ * @group phriction
*/
class PhrictionDocumentTestCase extends PhabricatorTestCase {
View
3 src/applications/search/constants/field/PhabricatorSearchField.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
final class PhabricatorSearchField {
const FIELD_TITLE = 'titl';
View
3 src/applications/search/constants/relationship/PhabricatorSearchRelationship.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
final class PhabricatorSearchRelationship {
const RELATIONSHIP_AUTHOR = 'auth';
View
3 src/applications/search/controller/attach/PhabricatorSearchAttachController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchAttachController extends PhabricatorSearchController {
private $phid;
View
3 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) {
View
3 src/applications/search/controller/index/PhabricatorSearchIndexController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchIndexController extends PhabricatorSearchBaseController {
private $phid;
View
3 src/applications/search/controller/search/PhabricatorSearchController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchController extends PhabricatorSearchBaseController {
private $id;
View
3 src/applications/search/controller/select/PhabricatorSearchSelectController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchSelectController
extends PhabricatorSearchController {
View
3 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(
View
3 src/applications/search/index/abstractdocument/PhabricatorSearchAbstractDocument.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
final class PhabricatorSearchAbstractDocument {
private $phid;
View
3 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?
View
3 src/applications/search/index/indexer/differential/PhabricatorSearchDifferentialIndexer.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchDifferentialIndexer
extends PhabricatorSearchDocumentIndexer {
View
3 src/applications/search/index/indexer/maniphest/PhabricatorSearchManiphestIndexer.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchManiphestIndexer
extends PhabricatorSearchDocumentIndexer {
View
3 src/applications/search/index/indexer/phriction/PhabricatorSearchPhrictionIndexer.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchPhrictionIndexer
extends PhabricatorSearchDocumentIndexer {
View
3 src/applications/search/index/indexer/repository/PhabricatorSearchCommitIndexer.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchCommitIndexer
extends PhabricatorSearchDocumentIndexer {
View
3 src/applications/search/index/indexer/user/PhabricatorSearchUserIndexer.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchUserIndexer
extends PhabricatorSearchDocumentIndexer {
View
3 src/applications/search/selector/base/PhabricatorSearchEngineSelector.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
abstract class PhabricatorSearchEngineSelector {
final public function __construct() {
View
3 src/applications/search/selector/default/PhabricatorDefaultSearchEngineSelector.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
final class PhabricatorDefaultSearchEngineSelector
extends PhabricatorSearchEngineSelector {
View
3 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() {
View
3 src/applications/search/storage/document/document/PhabricatorSearchDocument.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchDocument extends PhabricatorSearchDAO {
protected $phid;
View
3 src/applications/search/storage/document/field/PhabricatorSearchDocumentField.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchDocumentField extends PhabricatorSearchDAO {
protected $phid;
View
3 ...plications/search/storage/document/relationship/PhabricatorSearchDocumentRelationship.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchDocumentRelationship extends PhabricatorSearchDAO {
protected $phid;
View
3 src/applications/search/storage/query/PhabricatorSearchQuery.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
class PhabricatorSearchQuery extends PhabricatorSearchDAO {
protected $authorPHID;
View
3 src/applications/search/view/searchresult/PhabricatorSearchResultView.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group search
+ */
final class PhabricatorSearchResultView extends AphrontView {
private $handle;
View
3 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) {
View
3 src/applications/slowvote/controller/create/PhabricatorSlowvoteCreateController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group slowvote
+ */
class PhabricatorSlowvoteCreateController
extends PhabricatorSlowvoteController {
View
3 src/applications/slowvote/controller/list/PhabricatorSlowvoteListController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group slowvote
+ */
class PhabricatorSlowvoteListController
extends PhabricatorSlowvoteController {
View
3 src/applications/slowvote/controller/poll/PhabricatorSlowvotePollController.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group slowvote
+ */
class PhabricatorSlowvotePollController
extends PhabricatorSlowvoteController {
View
3 src/applications/slowvote/storage/base/PhabricatorSlowvoteDAO.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group slowvote
+ */
class PhabricatorSlowvoteDAO extends PhabricatorLiskDAO {
public function getApplicationName() {
View
3 src/applications/slowvote/storage/choice/PhabricatorSlowvoteChoice.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group slowvote
+ */
class PhabricatorSlowvoteChoice extends PhabricatorSlowvoteDAO {
protected $pollID;
View
3 src/applications/slowvote/storage/comment/PhabricatorSlowvoteComment.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group slowvote
+ */
class PhabricatorSlowvoteComment extends PhabricatorSlowvoteDAO {
protected $pollID;
View
3 src/applications/slowvote/storage/option/PhabricatorSlowvoteOption.php
@@ -16,6 +16,9 @@
* limitations under the License.
*/
+/**
+ * @group slowvote
+ */
class PhabricatorSlowvoteOption extends PhabricatorSlowvoteDAO {
protected $pollID;
View
3 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;
View
3 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

0 comments on commit 4bec257

Please sign in to comment.
Something went wrong with that request. Please try again.