Skip to content

ci: Change API Documentation template style #500

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 1 commit into from
Apr 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ ParseClient::setCAFile(__DIR__ . '/certs/cacert.pem');

We highly recommend you read through the [guide](http://docs.parseplatform.org/php/guide/) first. This will walk you through the basics of working with this sdk, as well as provide insight into how to best develop your project.

If want to know more about what makes the php sdk tick you can read our [API Reference](http://parseplatform.org/parse-php-sdk/namespaces/Parse.html) and flip through the code on [github](https://github.com/parse-community/parse-php-sdk/).
If want to know more about what makes the php sdk tick you can read our [API Reference](http://parseplatform.org/parse-php-sdk/namespaces/parse.html) and flip through the code on [github](https://github.com/parse-community/parse-php-sdk/).

Check out the [Parse PHP Guide] for the full documentation.

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@
"prestart": "MONGODB_VERSION=4.0.4 MONGODB_TOPOLOGY=replicaset MONGODB_STORAGE_ENGINE=wiredTiger mongodb-runner start",
"start": "TESTING=1 node ./tests/server.js &",
"server-only": "TESTING=1 node ./tests/server.js",
"document-check": "./vendor/bin/phpdoc -d ./src/ --template='responsive-twig'",
"document": "./vendor/bin/phpdoc -d ./src/ --title 'Parse PHP SDK API Reference' --template='responsive-twig'"
"document-check": "./vendor/bin/phpdoc -d ./src/ --template='default'",
"document": "./vendor/bin/phpdoc -d ./src/ --title 'Parse PHP SDK API Reference' --template='default'"
},
"type": "module",
"repository": {
"type": "git",
"url": "git+https://github.com/parse-community/parse-php-sdk"
},
"license": "BSD-3-Clause",
"homepage": "https://github.com/montymxb/parse-server-test#readme",
"homepage": "https://parseplatform.org",
"devDependencies": {
"@semantic-release/changelog": "6.0.3",
"@semantic-release/commit-analyzer": "9.0.2",
Expand Down
2 changes: 1 addition & 1 deletion src/Parse/ParseBytes.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public static function createFromBase64Data($base64Data)
/**
* Decodes and unpacks a given base64 encoded array of data
*
* @param $base64Data
* @param string $base64Data
*/
private function setBase64Data($base64Data)
{
Expand Down
4 changes: 2 additions & 2 deletions src/Parse/ParseFile.php
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,8 @@ public static function createFromFile($path, $name, $mimeType = null)
/**
* Internal method used when constructing a Parse File from Parse.
*
* @param $name
* @param $url
* @param string $name
* @param string $url
*
* @return ParseFile
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Parse/ParseGeoPoint.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public function getLatitude()
/**
* Set the Latitude value for this GeoPoint.
*
* @param $lat
* @param float $lat
*
* @throws ParseException
*/
Expand Down Expand Up @@ -82,7 +82,7 @@ public function getLongitude()
/**
* Set the Longitude value for this GeoPoint.
*
* @param $lon
* @param float $lon
*
* @throws ParseException
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Parse/ParseObject.php
Original file line number Diff line number Diff line change
Expand Up @@ -1548,7 +1548,7 @@ public static function _unregisterSubclass()
/**
* Check whether there is a subclass registered for a given parse class.
*
* @param $parseClassName
* @param string $parseClassName
*
* @return bool
*/
Expand All @@ -1561,7 +1561,7 @@ public static function hasRegisteredSubclass($parseClassName)
* Get the registered subclass for a Parse class, or a generic ParseObject
* if no subclass is registered.
*
* @param $parseClassName
* @param string $parseClassName
*
* @return ParseObject
*/
Expand Down
4 changes: 2 additions & 2 deletions src/Parse/ParseRelation.php
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ public function getTargetClass()
/**
* Set the target classname for the relation.
*
* @param $className
* @param string $className
*/
public function setTargetClass($className)
{
Expand All @@ -105,7 +105,7 @@ public function setTargetClass($className)
/**
* Set the parent object for the relation.
*
* @param $parent
* @param ParseObject $parent
*/
public function setParent($parent)
{
Expand Down