{"action":"created","issue":{"url":"https://api.github.com/repos/opensourcepos/opensourcepos/issues/1872","repository_url":"https://api.github.com/repos/opensourcepos/opensourcepos","labels_url":"https://api.github.com/repos/opensourcepos/opensourcepos/issues/1872/labels{/name}","comments_url":"https://api.github.com/repos/opensourcepos/opensourcepos/issues/1872/comments","events_url":"https://api.github.com/repos/opensourcepos/opensourcepos/issues/1872/events","html_url":"https://github.com/opensourcepos/opensourcepos/issues/1872","id":301674465,"number":1872,"title":"Code Documentation needed","user":{"login":"objecttothis","id":17935339,"avatar_url":"https://avatars1.githubusercontent.com/u/17935339?v=4","gravatar_id":"","url":"https://api.github.com/users/objecttothis","html_url":"https://github.com/objecttothis","followers_url":"https://api.github.com/users/objecttothis/followers","following_url":"https://api.github.com/users/objecttothis/following{/other_user}","gists_url":"https://api.github.com/users/objecttothis/gists{/gist_id}","starred_url":"https://api.github.com/users/objecttothis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/objecttothis/subscriptions","organizations_url":"https://api.github.com/users/objecttothis/orgs","repos_url":"https://api.github.com/users/objecttothis/repos","events_url":"https://api.github.com/users/objecttothis/events{/privacy}","received_events_url":"https://api.github.com/users/objecttothis/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":6,"created_at":"2018-03-02T07:15:09Z","updated_at":"2018-03-25T14:04:02Z","closed_at":null,"author_association":"COLLABORATOR","body":"### Background information\r\n\r\n__IMPORTANT: If you choose to ignore this issue report template, your issue will be closed as we cannot help without the requested information.__\r\n\r\nPlease make sure you tick (add an x between the square brackets with no spaces) the following check boxes:\r\n\r\n- [x] Reporting an issue of an unmodified OSPOS installation\r\n- [x] Checked [open and closed issues](https://github.com/opensourcepos/opensourcepos/issues?utf8=%E2%9C%93&q=is%3Aissue) and no similar issue was already reported (please make sure you searched!)\r\n- [x] Read [README](https://github.com/opensourcepos/opensourcepos/blob/master/README.md), [WHATS_NEW](https://github.com/opensourcepos/opensourcepos/blob/master/WHATS_NEW.txt) and [UPGRADE](https://github.com/opensourcepos/opensourcepos/blob/master/UPGRADE.txt)\r\n- [x] Read the [FAQ](https://github.com/opensourcepos/opensourcepos#faq) for any known install and/or upgrade gotchas (in specific PHP extensions installed)\r\n- [x] Read the [wiki](https://github.com/opensourcepos/opensourcepos/wiki)\r\n- [x] Executed any database upgrade scripts if an upgrade pre 3.0.0 (e.g. database/2.4_to_3.0.sql)\r\n- [x] Aware the installation code is in [bintray](https://bintray.com/jekkos/opensourcepos/opensourcepos/view/files?sort=updated&order=asc#files) (see README), and [GitHub master](https://github.com/opensourcepos/opensourcepos/tree/master) is for [developers only](https://github.com/opensourcepos/opensourcepos/wiki/Development-setup) and therefore not complete nor stable\r\n\r\n### Installation information\r\n\r\n- OSPOS version is: 3.2.0\r\n- OSPOS git commit hash is: \r\n- PHP version is:      (e.g. 5.5, 5.6, 7.0, 7.1) 5.6\r\n- MySQL or MariaDB version is:      (e.g. MySQL 5.5, MySQL 5.6, MySQL 5.7, MariaDB 10.0, MariaDB 10.1, MariaDB 10.2) MySQL 5.7\r\n- OS and version is:      (e.g. CentOS 6.9, Ubuntu 16.4, Windows 10) FreeBSD 11.1\r\n- WebServer is:      (e.g. Apache 2.2, Apache 2.4, Nginx 1.12, Nginx 1.13) Apache 2.4\r\n- (If applicable) Docker installation: \r\n- (If applicable) Installation package for the LAMP/LEMP stack is:      (e.g. WAMP, XAMPP)\r\n\r\n### Issue / Bug  / Question / New Feature\r\n\r\nCurrently there is very little documentation of the code.  It would be a lot of work to manually document all methods and classes.  What if we use something like PHPDoc2 https://github.com/phpDocumentor/phpDocumentor2 which has become sort of a de facto standard with documentation to automatically document functions and classes in the master code?"},"comment":{"url":"https://api.github.com/repos/opensourcepos/opensourcepos/issues/comments/375972921","html_url":"https://github.com/opensourcepos/opensourcepos/issues/1872#issuecomment-375972921","issue_url":"https://api.github.com/repos/opensourcepos/opensourcepos/issues/1872","id":375972921,"user":{"login":"mckaygerhard","id":1571724,"avatar_url":"https://avatars1.githubusercontent.com/u/1571724?v=4","gravatar_id":"","url":"https://api.github.com/users/mckaygerhard","html_url":"https://github.com/mckaygerhard","followers_url":"https://api.github.com/users/mckaygerhard/followers","following_url":"https://api.github.com/users/mckaygerhard/following{/other_user}","gists_url":"https://api.github.com/users/mckaygerhard/gists{/gist_id}","starred_url":"https://api.github.com/users/mckaygerhard/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mckaygerhard/subscriptions","organizations_url":"https://api.github.com/users/mckaygerhard/orgs","repos_url":"https://api.github.com/users/mckaygerhard/repos","events_url":"https://api.github.com/users/mckaygerhard/events{/privacy}","received_events_url":"https://api.github.com/users/mckaygerhard/received_events","type":"User","site_admin":false},"created_at":"2018-03-25T14:04:02Z","updated_at":"2018-03-25T14:04:02Z","author_association":"CONTRIBUTOR","body":"hi @jekkos and @objecttothis i added some code tips to the wiki that help to start code, this in combination with the @daN4cat API documentation should be enought to make features and new pieces of code to the project.. chek it and hope will be usefully\r\nPD: still need some reorganization but i'm working on.. in a parallel wiki and put later"}}
{"actor":{"display_login":"mckaygerhard"}}