@tsteur opened this Issue on October 7th 2013 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 commented on October 18th 2013 Member

In 2e8317c70937995cc6c72d8c3abb6e44f0e6e796: 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 commented on October 18th 2013 Member

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

@diosmosis commented on October 18th 2013 Member

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

@diosmosis commented on October 19th 2013 Member

In aee8e5caada59017bc39f52ad72a91e10e8cd200: Refs #4200, documented Date object.

@diosmosis commented on October 19th 2013 Member

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

@diosmosis commented on October 20th 2013 Member

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

@diosmosis commented on October 20th 2013 Member

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

@diosmosis commented on October 20th 2013 Member

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

@diosmosis commented on October 20th 2013 Member

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

@diosmosis commented on October 20th 2013 Member

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

@diosmosis commented on October 20th 2013 Member

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

@diosmosis commented on October 20th 2013 Member

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

@diosmosis commented on October 20th 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

In e74ecaf307804e0f9d37c7842f9fbbd9f36ba8bb: Refs #4200, documented Mail class.

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 21st 2013 Member

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

@diosmosis commented on October 22nd 2013 Member

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

@diosmosis commented on October 22nd 2013 Member

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

@diosmosis commented on October 22nd 2013 Member

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

@diosmosis commented on October 22nd 2013 Member

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

@diosmosis commented on October 22nd 2013 Member

In fe631813a815510a5a9a96a476deaab9444cb614: 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 commented on October 22nd 2013 Member

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

@diosmosis commented on October 23rd 2013 Member

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

@diosmosis commented on October 23rd 2013 Member

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

@diosmosis commented on October 23rd 2013 Member

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

@diosmosis commented on October 23rd 2013 Member

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

@diosmosis commented on October 24th 2013 Member

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

@diosmosis commented on October 24th 2013 Member

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

@diosmosis commented on October 24th 2013 Member

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

@diosmosis commented on October 24th 2013 Member

In b280ed78bc920e9c397b128fe0a3995c2685e732: Refs #4200, documented ControllerAdmin.

@diosmosis commented on October 24th 2013 Member

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

@diosmosis commented on October 25th 2013 Member

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

@diosmosis commented on October 26th 2013 Member

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

@mattab commented on October 31st 2013 Member

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

@diosmosis commented on November 1st 2013 Member

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

@diosmosis commented on November 1st 2013 Member

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

@diosmosis commented on November 1st 2013 Member

In 6ad190a3409f7edfc9240a8ca84bf70ddb7e4cda: 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 commented on November 9th 2013 Member

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

@diosmosis commented on November 11th 2013 Member

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

@diosmosis commented on November 11th 2013 Member

In f6d5461b5ad85ebf7293d30a01225bc427710141: Refs #4200, finished documenting LogAggregator.

@diosmosis commented on November 12th 2013 Member

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

@diosmosis commented on November 12th 2013 Member

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

@diosmosis commented on November 13th 2013 Member

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

@diosmosis commented on November 13th 2013 Member

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

@diosmosis commented on November 13th 2013 Member

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

@diosmosis commented on November 18th 2013 Member

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

@diosmosis commented on November 18th 2013 Member

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

@diosmosis commented on November 26th 2013 Member

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

@diosmosis commented on December 6th 2013 Member

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

@diosmosis commented on December 8th 2013 Member

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

@diosmosis commented on December 8th 2013 Member

In ea592dc85343c97ce6d2da4b2d3594f10363d1e8: Refs #4200 tweaks to last commit.

@diosmosis commented on December 8th 2013 Member

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

This Issue was closed on December 8th 2013
Powered by GitHub Issue Mirror