Create Framework Documentation for developers (php source code doc) #4200

Closed
tsteur opened this Issue Oct 7, 2013 · 77 comments

3 participants

@tsteur
Piwik Open Source Analytics member

Follow up to #4194. Some classes, methods, properties, constants do not have a documentation or not a very useful documentation. Some might be outdated. See https://github.com/piwik/pluginapi-doc-generator/tree/master/docs/master

The documentation should be completed so that plugin developers can enjoy a nice and complete documentation.

@diosmosis
Piwik Open Source Analytics member

In 2e8317c: Refs #4200, do not generate docs for CacheFile class, document @api methods in Common, remove unused Common:: var, remove Common::substr and Common::strlen.

@diosmosis
Piwik Open Source Analytics member

In 4535508: Refs #4200, documented Config.php.

@diosmosis
Piwik Open Source Analytics member

In 1a6ab30: Refs #4200, started documentation of DataTable class.

@diosmosis
Piwik Open Source Analytics member

In aee8e5c: Refs #4200, documented Date object.

@diosmosis
Piwik Open Source Analytics member

In 0a9ad10: Refs #4200, documented Db.php and small refactor to LogDataPurger/ReportsPurger (allow order by to be unspecified).

@diosmosis
Piwik Open Source Analytics member

In 7c58e92: Refs #4200, documented the Filesystem class.

@diosmosis
Piwik Open Source Analytics member

In 32fceb0: Refs #4200, finished documenting FrontController.

@diosmosis
Piwik Open Source Analytics member

In 87756a9: Refs #4200, documented Http class.

@diosmosis
Piwik Open Source Analytics member

In 662babf: Refs #4200, tweaked docs for core/IP.php.

@diosmosis
Piwik Open Source Analytics member

In 9ca9d75: Refs #4200, added more documentation to the Log class and modified default value of log_file_path config option.

@diosmosis
Piwik Open Source Analytics member

In 822a310: Refs #4200, documented Mail class.

@diosmosis
Piwik Open Source Analytics member

In c753044: Refs #4200, documented several more classes.

@diosmosis
Piwik Open Source Analytics member

In 115a695: Refs #4200, finish documenting core/Piwik.php.

@diosmosis
Piwik Open Source Analytics member

In 2c8c5c5: Refs #4200, tweaked RankingQuery docs.

@diosmosis
Piwik Open Source Analytics member

In 7ffb3f1: Refs #4200, documented core/Segment.php

@diosmosis
Piwik Open Source Analytics member

In 1c77478: Refs #4200, documented core/SettingsServer.php.

@diosmosis
Piwik Open Source Analytics member

In 23c843b: Refs #4200, documented core/Singleton.php and core/Site.php and set method visibility for Site.

@diosmosis
Piwik Open Source Analytics member

In 1f41982: Refs #4200, documented Date object.

@diosmosis
Piwik Open Source Analytics member

In a8fa6d0: Refs #4200, documented Db.php and small refactor to LogDataPurger/ReportsPurger (allow order by to be unspecified).

@diosmosis
Piwik Open Source Analytics member

In bf6f627: Refs #4200, documented the Filesystem class.

@diosmosis
Piwik Open Source Analytics member

In 21b1c00: Refs #4200, finished documenting FrontController.

@diosmosis
Piwik Open Source Analytics member

In 31fe034: Refs #4200, documented Http class.

@diosmosis
Piwik Open Source Analytics member

In 6eca3fa: Refs #4200, tweaked docs for core/IP.php.

@diosmosis
Piwik Open Source Analytics member

In 5e5e45f: Refs #4200, added more documentation to the Log class and modified default value of log_file_path config option.

@diosmosis
Piwik Open Source Analytics member

In e74ecaf: Refs #4200, documented Mail class.

@diosmosis
Piwik Open Source Analytics member

In f7e7028: Refs #4200, documented several more classes.

@diosmosis
Piwik Open Source Analytics member

In 9805571: Refs #4200, finish documenting core/Piwik.php.

@diosmosis
Piwik Open Source Analytics member

In 7f5b9f3: Refs #4200, tweaked RankingQuery docs.

@diosmosis
Piwik Open Source Analytics member

In 91f6498: Refs #4200, documented core/Segment.php

@diosmosis
Piwik Open Source Analytics member

In 085b26c: Refs #4200, documented core/SettingsServer.php.

@diosmosis
Piwik Open Source Analytics member

In eab2bac: Refs #4200, documented core/Singleton.php and core/Site.php and set method visibility for Site.

@diosmosis
Piwik Open Source Analytics member

In d67738a: Refs #4200, documented task scheduler class.

@diosmosis
Piwik Open Source Analytics member

In 6f1f458: Refs #4200, revert getAllTableMetadata function removal and document core/Url.php.

@diosmosis
Piwik Open Source Analytics member

In d25f87b: Refs #4200, documented core/UrlHelper.php and core/Version.php.

@diosmosis
Piwik Open Source Analytics member

In 4c212e1: Refs #4200 documented core/View.php and core/WidgetsList.php

@diosmosis
Piwik Open Source Analytics member

In 055eaa8: Refs #4200 documented core/API/Request.php and part of core/DataTable/Simple.php

@diosmosis
Piwik Open Source Analytics member

In 6afd88e: Refs #4200, documented core/DataTable/Simple.php.

@diosmosis
Piwik Open Source Analytics member

In 8173fe7: Refs #4200 documented core/DataTable/Row.php.

@diosmosis
Piwik Open Source Analytics member

In 8e99a08: Refs #4200 document core/DataTable/Filter.php and core/DataTable/Map.php and fix build.

@diosmosis
Piwik Open Source Analytics member

In 5e50f5f: Refs #4200, added docs for DataTableSummaryRow and AddColumnsProcessedMetrics.

@diosmosis
Piwik Open Source Analytics member

In 54a488c: Refs #4200 fixing build and documented AddColumnsProcessedMetricsGoal.

@diosmosis
Piwik Open Source Analytics member

In a10eb83: Refs #4200, make DataTable:: private & add public methods necessary, tweaking some filter docs, and remove AddConstantMetadata filter.

@diosmosis
Piwik Open Source Analytics member

In 66add89: Refs #4200, change function of AddSummaryRow and move logic to Truncate filter.

@diosmosis
Piwik Open Source Analytics member

In 777fa7f: Refs #4200, move AddSummaryRow logic to Truncate, change AddSummaryRow logic to just add a summary row and fix bug in FrontController.

@diosmosis
Piwik Open Source Analytics member

In f3ff0cf: Refs #4200, remove parameter from Truncate filter,and document AddSummaryRow and Truncate filters.

@diosmosis
Piwik Open Source Analytics member

In fe63181: Refs #4200, documented many more filters and modified ColumnCallbackDeleteRow so filter supplied returns true if the row should be deleted (as opposed to the other way around).

@diosmosis
Piwik Open Source Analytics member

In 28d107b: Refs #4200, removed Null filter and documented many more filters.

@diosmosis
Piwik Open Source Analytics member

In ad1e017: Refs #4200, document rest of DataTable filters.

@diosmosis
Piwik Open Source Analytics member

In a6f631c: Refs #4200, documented the ArchiveProcessor class.

@diosmosis
Piwik Open Source Analytics member

In 475a7cc: Refs #4200, documented Period ArchiveProcessor and started documenting Day ArchiveProcessor.

@diosmosis
Piwik Open Source Analytics member

In c70f21f: Refs #4200, document core/Menu/*.php and core/Period/Range.php and remove Range::removePeriod and replace w/ Date::addPeriod.

@diosmosis
Piwik Open Source Analytics member

In 0cb0472: Refs #4200 started documenting LogAggregator and documented Plugin/API.

@diosmosis
Piwik Open Source Analytics member

In afed69c: Refs #4200, documented core/Plugin/API, core/Plugin/Archiver and part of core/Plugin/Controller.

@diosmosis
Piwik Open Source Analytics member

In cc4a1dc: Refs #4200, finished documenting core/Plugin/Controller and moved Controller::getRelativeToEndDate to Range.

@diosmosis
Piwik Open Source Analytics member

In b280ed7: Refs #4200, documented ControllerAdmin.

@diosmosis
Piwik Open Source Analytics member

In ba855ae: Refs #4200, documented core/Plugin/Manager and removed @api tag from core/Tracker/Visit.

@diosmosis
Piwik Open Source Analytics member

In 145fcb5: Refs #4200 revised event docs for core/* files.

@diosmosis
Piwik Open Source Analytics member

In 9573c33: Refs #4200, revised documentation for all events in plugins/*.

@mattab
Piwik Open Source Analytics member

Amazing work @capedfuzz. A quest it is to document Piwik.

@diosmosis
Piwik Open Source Analytics member

In ea77c15: Refs #4200, documented more of LogAggregator class.

@diosmosis
Piwik Open Source Analytics member

In d6a5347: Refs #4200, documented the ScheduledTask class.

@diosmosis
Piwik Open Source Analytics member

In 6ad190a: Refs #4200, documented ScheduledTime a bit and added a factory method that can be used to create ScheduledTime instances w/ one line of code.

@diosmosis
Piwik Open Source Analytics member

In da2cd08: Refs #4200, refactor LogAggregator a bit (change signature of getSelectsFromRangedColumn) and document a bit more.

@diosmosis
Piwik Open Source Analytics member

In b43402d: Refs #4200, document last method in LogAggregator.

@diosmosis
Piwik Open Source Analytics member

In f6d5461: Refs #4200, finished documenting LogAggregator.

@diosmosis
Piwik Open Source Analytics member

In 7b17290: Refs #4200, revised documentation for core/Settings/Setting.php and changed names of some fields.

@diosmosis
Piwik Open Source Analytics member

In 5570533: Refs #4200, documenting more Settings related classes and fixing build.

@diosmosis
Piwik Open Source Analytics member

In 5b8d794: Refs #4200, revised documentation of Notification classes.

@diosmosis
Piwik Open Source Analytics member

In 631ae84: Refs #4200, finished documenting scheduled task related classes.

@diosmosis
Piwik Open Source Analytics member

In e9bbb89: Refs #4200, documented some of ViewDataTable and ViewDataTable\Config.

@diosmosis
Piwik Open Source Analytics member

In e18a6a2: Refs #4200, finished documenting ViewDataTable\Config class.

@diosmosis
Piwik Open Source Analytics member

In 82a36f1: Refs #4200, documented ViewDataTable\Factory.

@diosmosis
Piwik Open Source Analytics member

In c8880f4: Refs #4200, fixing typo in method name and tweaking docs.

@diosmosis
Piwik Open Source Analytics member

In 87d676d: Refs #4200, documented undocumented visualization classes.

@diosmosis
Piwik Open Source Analytics member

In 4cafa9e: Refs #4200 revised some of class/method docs.

@diosmosis
Piwik Open Source Analytics member

In ea592dc: Refs #4200 tweaks to last commit.

@diosmosis
Piwik Open Source Analytics member

In 13297a8: Fixes #4200, revised rest of @api classes/methods, closing ticket.

@tsteur tsteur added this to the 2.0 - Piwik 2.0 milestone Jul 8, 2014
@mattab mattab was assigned by tsteur Jul 8, 2014
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, do not generate docs for CacheFile class, document @api m…
…ethods in Common, remove unused Common:: var, remove Common::substr and Common::strlen.
2e8317c
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented Config.php. 4535508
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, started documentation of DataTable class. 1a6ab30
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented Date object. 1f41982
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented Db.php and small refactor to LogDataPurger/Rep…
…ortsPurger (allow order by to be unspecified).
a8fa6d0
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented the Filesystem class. bf6f627
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, finished documenting FrontController. 21b1c00
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented Http class. 31fe034
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, tweaked docs for core/IP.php. 6eca3fa
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, added more documentation to the Log class and modified de…
…fault value of log_file_path config option.
5e5e45f
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented Mail class. e74ecaf
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented several more classes. f7e7028
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, finish documenting core/Piwik.php. 9805571
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, tweaked RankingQuery docs. 7f5b9f3
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented core/Segment.php 91f6498
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented core/SettingsServer.php. 085b26c
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented core/Singleton.php and core/Site.php and set m…
…ethod visibility for Site.
eab2bac
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented task scheduler class. d67738a
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, revert getAllTableMetadata function removal and document …
…core/Url.php.
6f1f458
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200 documented core/View.php and core/WidgetsList.php 4c212e1
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200 documented core/API/Request.php and part of core/DataTable…
…/Simple.php
055eaa8
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented core/DataTable/Simple.php. 6afd88e
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200 documented core/DataTable/Row.php. 8173fe7
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200 document core/DataTable/Filter.php and core/DataTable/Map.…
…php and fix build.
8e99a08
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, added docs for DataTableSummaryRow and AddColumnsProcesse…
…dMetrics.
5e50f5f
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, make DataTable:: private & add public methods necessary, …
…tweaking some filter docs, and remove AddConstantMetadata filter.
a10eb83
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, change function of AddSummaryRow and move logic to Trunca…
…te filter.
66add89
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, move AddSummaryRow logic to Truncate, change AddSummaryRo…
…w logic to just add a summary row and fix bug in FrontController.
777fa7f
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, remove parameter from Truncate filter,and document AddSum…
…maryRow and Truncate filters.
f3ff0cf
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented many more filters and modified ColumnCallbackD…
…eleteRow so filter supplied returns true if the row should be deleted (as opposed to the other way around).
fe63181
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, document rest of DataTable filters. ad1e017
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented the ArchiveProcessor class. a6f631c
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented Period ArchiveProcessor and started documentin…
…g Day ArchiveProcessor.
475a7cc
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, document core/Menu/*.php and core/Period/Range.php and re…
…move Range::removePeriod and replace w/ Date::addPeriod.
c70f21f
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented core/Plugin/API, core/Plugin/Archiver and part…
… of core/Plugin/Controller.
afed69c
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, finished documenting core/Plugin/Controller and moved Con…
…troller::getRelativeToEndDate to Range.
cc4a1dc
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented ControllerAdmin. b280ed7
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented core/Plugin/Manager and removed @api tag from …
…core/Tracker/Visit.
ba855ae
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200 revised event docs for core/* files. 145fcb5
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented more of LogAggregator class. ea77c15
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented the ScheduledTask class. d6a5347
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented ScheduledTime a bit and added a factory method…
… that can be used to create ScheduledTime instances w/ one line of code.
6ad190a
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, refactor LogAggregator a bit (change signature of getSele…
…ctsFromRangedColumn) and document a bit more.
da2cd08
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, document last method in LogAggregator. b43402d
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, finished documenting LogAggregator. f6d5461
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, tweaking ArchiveProcessor docs. 55b8645
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented Archiver class. f163f2e
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@mattab mattab Remove TaskScheduler from @api refs #4200 378bfbe
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, revised documentation for core/Settings/Setting.php and c…
…hanged names of some fields.
7b17290
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, revised documentation of Notification classes. 5b8d794
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented ViewDataTable\Factory. 82a36f1
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, fixing typo in method name and tweaking docs. c8880f4
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200, documented undocumented visualization classes. 87d676d
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200 revised some of class/method docs. 4cafa9e
@sabl0r sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
@diosmosis diosmosis Refs #4200 tweaks to last commit. ea592dc
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment