Skip to content

Corrects and updates phpdoc references/errors #329

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

Merged
merged 2 commits into from
Jun 27, 2017

Conversation

montymxb
Copy link
Contributor

The php sdk has docs online at parseplatform.org/parse-php-sdk/. But they are rather outdated from 2015.

This updates the existing documentation and corrects any documentation errors for proper generation of updated docs. Once this is in place we can generate new docs using npm run document, which can be added to our gh-pages branch.

Note that generation of docs requires the GraphViz package to create a class inheritance diagram.

@codecov
Copy link

codecov bot commented Jun 27, 2017

Codecov Report

Merging #329 into master will increase coverage by 0.71%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #329      +/-   ##
==========================================
+ Coverage   98.05%   98.76%   +0.71%     
==========================================
  Files          35       34       -1     
  Lines        2718     2682      -36     
==========================================
- Hits         2665     2649      -16     
+ Misses         53       33      -20
Impacted Files Coverage Δ
src/Parse/ParseQuery.php 99.23% <ø> (ø) ⬆️
src/Parse/ParseObject.php 97.12% <ø> (ø) ⬆️
src/Parse/ParseInstallation.php 100% <ø> (ø) ⬆️
src/Parse/ParseHooks.php 100% <ø> (ø) ⬆️
src/Parse/HttpClients/ParseCurlHttpClient.php 98.88% <ø> (ø) ⬆️
src/Parse/ParseUser.php 98.11% <ø> (ø) ⬆️
src/Parse/ParseAggregateException.php 100% <ø> (ø) ⬆️
src/Parse/ParseSchema.php 97.07% <ø> (ø) ⬆️
src/Parse/ParseSessionStorage.php 100% <ø> (ø) ⬆️
src/Parse/ParseBytes.php 100% <ø> (ø) ⬆️
... and 24 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6fab212...b356197. Read the comment docs.

@montymxb montymxb merged commit a0a91a9 into parse-community:master Jun 27, 2017
@montymxb montymxb deleted the doc-update branch June 27, 2017 20:02
dplewis pushed a commit to dplewis/parse-php-sdk that referenced this pull request Jul 12, 2017
* Corrects and updates phpdoc references/errors

* Lint fixes
montymxb pushed a commit that referenced this pull request Jul 12, 2017
* Add ParsePolygon Type and polygonContains query

* test class fix

* error handling for polygon

* Update PHP_CodeSniffer (#328)

* Add lint

* update travis

* coding style

* add coverage to gitignore

* removed ignore lines

* nit

* Updated parse-php-sdk to version 1.2.9

* Corrects and updates phpdoc references/errors (#329)

* Corrects and updates phpdoc references/errors

* Lint fixes

* Added 'Getting Started' to README.md

Adds a **Getting Started** section to README.md to direct newcomers to the [official guide](http://docs.parseplatform.org/php/guide/) and [API reference](http://parseplatform.org/parse-php-sdk/namespaces/Parse.html).

* Remove Default API (#332)

* Removed default api and added appropriate checking

* lint

* Pages autodeploy and phpdoc style enforcing (#335)

* Added 'document-check' to add phpdoc checking during tests and added deploy for api ref on gh-pages

* Wrapping filename in quotes

* Moved bash out of package.json

* Unescaping strings

* Testing missing block comment

* Fixing lint exception to expose phpdoc style issue

* Restored class summary

* removed comment

* fix documentation

* Pinned jms/serializer to 1.7.1 (#336)

* Pinned jms/serializer to 1.7.1

* Checking to update jms/serializer to 1.8.0 ONLY on php 5.4 for travis-ci

* Added comment, and added graphviz for class diagrams in generated api docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant