Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

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

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

tsteur opened this issue Oct 7, 2013 · 77 comments
Assignees
Labels
Critical Indicates the severity of an issue is very critical and the issue has a very high priority. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Milestone

Comments

@tsteur
Copy link
Member

tsteur commented Oct 7, 2013

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
Copy link
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
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

In aee8e5c: Refs #4200, documented Date object.

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

In e74ecaf: Refs #4200, documented Mail class.

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

@diosmosis
Copy link
Member

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

sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
…php and remove Range::removePeriod and replace w/ Date::addPeriod.
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
… moved Controller::getRelativeToEndDate to Range.
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
…ory method that can be used to create ScheduledTime instances w/ one line of code.
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
…of getSelectsFromRangedColumn) and document a bit more.
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
sabl0r pushed a commit to sabl0r/piwik that referenced this issue Sep 23, 2014
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Critical Indicates the severity of an issue is very critical and the issue has a very high priority. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Projects
None yet
Development

No branches or pull requests

3 participants