Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

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

Closed
tsteur opened this Issue · 77 comments

3 participants

Thomas Steur Benaka Matthieu Aubry
Thomas Steur
Owner

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.

Benaka
Collaborator

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.

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

In aee8e5c: Refs #4200, documented Date object.

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

In e74ecaf: Refs #4200, documented Mail class.

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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).

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

In b280ed7: Refs #4200, documented ControllerAdmin.

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Matthieu Aubry
Owner

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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.

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

In f6d5461: Refs #4200, finished documenting LogAggregator.

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

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

Benaka
Collaborator

In ea592dc: Refs #4200 tweaks to last commit.

Benaka
Collaborator

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

Thomas Steur tsteur added this to the 2.0 - Piwik 2.0 milestone
Matthieu Aubry mattab was assigned by tsteur
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka 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
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented Config.php. 4535508
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented Date object. 1f41982
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented Db.php and small refactor to LogDataPurger/Rep…
…ortsPurger (allow order by to be unspecified).
a8fa6d0
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented the Filesystem class. bf6f627
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, finished documenting FrontController. 21b1c00
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented Http class. 31fe034
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, tweaked docs for core/IP.php. 6eca3fa
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, added more documentation to the Log class and modified de…
…fault value of log_file_path config option.
5e5e45f
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented Mail class. e74ecaf
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented several more classes. f7e7028
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, finish documenting core/Piwik.php. 9805571
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, tweaked RankingQuery docs. 7f5b9f3
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented core/Segment.php 91f6498
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented core/SettingsServer.php. 085b26c
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented core/Singleton.php and core/Site.php and set m…
…ethod visibility for Site.
eab2bac
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented task scheduler class. d67738a
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, revert getAllTableMetadata function removal and document …
…core/Url.php.
6f1f458
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200 documented core/API/Request.php and part of core/DataTable…
…/Simple.php
055eaa8
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented core/DataTable/Simple.php. 6afd88e
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200 documented core/DataTable/Row.php. 8173fe7
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200 document core/DataTable/Filter.php and core/DataTable/Map.…
…php and fix build.
8e99a08
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, make DataTable:: private & add public methods necessary, …
…tweaking some filter docs, and remove AddConstantMetadata filter.
a10eb83
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, move AddSummaryRow logic to Truncate, change AddSummaryRo…
…w logic to just add a summary row and fix bug in FrontController.
777fa7f
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, remove parameter from Truncate filter,and document AddSum…
…maryRow and Truncate filters.
f3ff0cf
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka 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
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, document rest of DataTable filters. ad1e017
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented the ArchiveProcessor class. a6f631c
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented Period ArchiveProcessor and started documentin…
…g Day ArchiveProcessor.
475a7cc
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, document core/Menu/*.php and core/Period/Range.php and re…
…move Range::removePeriod and replace w/ Date::addPeriod.
c70f21f
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented core/Plugin/API, core/Plugin/Archiver and part…
… of core/Plugin/Controller.
afed69c
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, finished documenting core/Plugin/Controller and moved Con…
…troller::getRelativeToEndDate to Range.
cc4a1dc
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented ControllerAdmin. b280ed7
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented core/Plugin/Manager and removed @api tag from …
…core/Tracker/Visit.
ba855ae
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200 revised event docs for core/* files. 145fcb5
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented the ScheduledTask class. d6a5347
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka 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
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, refactor LogAggregator a bit (change signature of getSele…
…ctsFromRangedColumn) and document a bit more.
da2cd08
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, document last method in LogAggregator. b43402d
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, finished documenting LogAggregator. f6d5461
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, tweaking ArchiveProcessor docs. 55b8645
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented Archiver class. f163f2e
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Matthieu Aubry mattab Remove TaskScheduler from @api refs #4200 378bfbe
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, revised documentation for core/Settings/Setting.php and c…
…hanged names of some fields.
7b17290
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200, documented ViewDataTable\Factory. 82a36f1
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka diosmosis Refs #4200 revised some of class/method docs. 4cafa9e
Philip Taffner sabl0r referenced this issue from a commit in sabl0r/piwik
Benaka 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
Something went wrong with that request. Please try again.