Skip to content

Cleaner documentation for Travis CI static tests #18386

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 5 commits into from
Apr 5, 2019
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
19 changes: 15 additions & 4 deletions app/code/Magento/Customer/Model/Address.php
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ public function __construct(
}

/**
* Init model
* Initialize address model
*
* @return void
*/
Expand Down Expand Up @@ -167,7 +167,14 @@ public function updateData(AddressInterface $address)
}

/**
* @inheritdoc
* Create address data object based on current address model.
*
* @param int|null $defaultBillingAddressId
* @param int|null $defaultShippingAddressId
* @return AddressInterface
* Use Api/Data/AddressInterface as a result of service operations. Don't rely on the model to provide
* the instance of Api/Data/AddressInterface
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
*/
public function getDataModel($defaultBillingAddressId = null, $defaultShippingAddressId = null)
{
Expand Down Expand Up @@ -257,7 +264,7 @@ public function getDefaultAttributeCodes()
}

/**
* Clone object handler
* Clone address
*
* @return void
*/
Expand Down Expand Up @@ -356,7 +363,11 @@ public function reindex()
}

/**
* @inheritdoc
* Get a list of custom attribute codes.
*
* By default, entity can be extended only using extension attributes functionality.
*
* @return string[]
* @since 100.0.6
*/
protected function getCustomAttributesCodes()
Expand Down
6 changes: 3 additions & 3 deletions app/code/Magento/Customer/Model/Customer.php
Original file line number Diff line number Diff line change
Expand Up @@ -1305,7 +1305,7 @@ public function getResetPasswordLinkExpirationPeriod()
}

/**
* Create address instance
* Create Address from Factory
*
* @return Address
*/
Expand All @@ -1315,7 +1315,7 @@ protected function _createAddressInstance()
}

/**
* Create address collection instance
* Create Address Collection from Factory
*
* @return \Magento\Customer\Model\ResourceModel\Address\Collection
*/
Expand All @@ -1325,7 +1325,7 @@ protected function _createAddressCollection()
}

/**
* Returns templates types
* Get Template Types
*
* @return array
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,14 @@ public function __construct(
}

/**
* @inheritdoc
* Create or update a customer.
*
* @param \Magento\Customer\Api\Data\CustomerInterface $customer
* @param string $passwordHash
* @return \Magento\Customer\Api\Data\CustomerInterface
* @throws \Magento\Framework\Exception\InputException If bad input is provided
* @throws \Magento\Framework\Exception\State\InputMismatchException If the provided email is already used
* @throws \Magento\Framework\Exception\LocalizedException
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
* @SuppressWarnings(PHPMD.NPathComplexity)
*/
Expand Down Expand Up @@ -304,7 +311,13 @@ private function populateCustomerWithSecureData($customerModel, $passwordHash =
}

/**
* @inheritdoc
* Retrieve customer.
*
* @param string $email
* @param int|null $websiteId
* @return \Magento\Customer\Api\Data\CustomerInterface
* @throws \Magento\Framework\Exception\NoSuchEntityException If customer with the specified email does not exist.
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function get($email, $websiteId = null)
{
Expand All @@ -313,7 +326,12 @@ public function get($email, $websiteId = null)
}

/**
* @inheritdoc
* Get customer by Customer ID.
*
* @param int $customerId
* @return \Magento\Customer\Api\Data\CustomerInterface
* @throws \Magento\Framework\Exception\NoSuchEntityException If customer with the specified ID does not exist.
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function getById($customerId)
{
Expand All @@ -322,7 +340,15 @@ public function getById($customerId)
}

/**
* @inheritdoc
* Retrieve customers which match a specified criteria.
*
* This call returns an array of objects, but detailed information about each object’s attributes might not be
* included. See http://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine
* which call to use to get detailed information about all attributes for an object.
*
* @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
* @return \Magento\Customer\Api\Data\CustomerSearchResultsInterface
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function getList(SearchCriteriaInterface $searchCriteria)
{
Expand Down Expand Up @@ -362,15 +388,24 @@ public function getList(SearchCriteriaInterface $searchCriteria)
}

/**
* @inheritdoc
* Delete customer.
*
* @param \Magento\Customer\Api\Data\CustomerInterface $customer
* @return bool true on success
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function delete(CustomerInterface $customer)
{
return $this->deleteById($customer->getId());
}

/**
* @inheritdoc
* Delete customer by Customer ID.
*
* @param int $customerId
* @return bool true on success
* @throws \Magento\Framework\Exception\NoSuchEntityException
* @throws \Magento\Framework\Exception\LocalizedException
*/
public function deleteById($customerId)
{
Expand Down