search

parse-community / parse-php-sdk

The PHP SDK for Parse Platform
https://parseplatform.org/
Other
811 stars 346 forks source link

Corrects and updates phpdoc references/errors #329

Closed montymxb closed 7 years ago

montymxb commented 7 years ago

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[bot] commented 7 years ago

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% <ø> (ø) :arrow_up:
src/Parse/ParseObject.php 97.12% <ø> (ø) :arrow_up:
src/Parse/ParseInstallation.php 100% <ø> (ø) :arrow_up:
src/Parse/ParseHooks.php 100% <ø> (ø) :arrow_up:
src/Parse/HttpClients/ParseCurlHttpClient.php 98.88% <ø> (ø) :arrow_up:
src/Parse/ParseUser.php 98.11% <ø> (ø) :arrow_up:
src/Parse/ParseAggregateException.php 100% <ø> (ø) :arrow_up:
src/Parse/ParseSchema.php 97.07% <ø> (ø) :arrow_up:
src/Parse/ParseSessionStorage.php 100% <ø> (ø) :arrow_up:
src/Parse/ParseBytes.php 100% <ø> (ø) :arrow_up:
... 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.