Skip to content

Commit 34fdfec

Browse files
committed
Fix phpdocumentor - inheritdoc imports long description only
1 parent bd224a5 commit 34fdfec

File tree

3 files changed

+63
-6
lines changed

3 files changed

+63
-6
lines changed

app/code/Magento/Customer/Model/Address.php

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,8 @@ public function __construct(
122122
}
123123

124124
/**
125+
* Initialize address model
126+
*
125127
* @return void
126128
*/
127129
protected function _construct()
@@ -168,7 +170,14 @@ public function updateData(AddressInterface $address)
168170
}
169171

170172
/**
171-
* {@inheritdoc}
173+
* Create address data object based on current address model.
174+
*
175+
* @param int|null $defaultBillingAddressId
176+
* @param int|null $defaultShippingAddressId
177+
* @return AddressInterface
178+
* Use Api/Data/AddressInterface as a result of service operations. Don't rely on the model to provide
179+
* the instance of Api/Data/AddressInterface
180+
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
172181
*/
173182
public function getDataModel($defaultBillingAddressId = null, $defaultShippingAddressId = null)
174183
{
@@ -261,6 +270,8 @@ public function getDefaultAttributeCodes()
261270
}
262271

263272
/**
273+
* Clone address
274+
*
264275
* @return void
265276
*/
266277
public function __clone()
@@ -301,6 +312,8 @@ public function setRegionId($regionId)
301312
}
302313

303314
/**
315+
* Create Customer from Factory
316+
*
304317
* @return Customer
305318
*/
306319
protected function _createCustomer()
@@ -356,7 +369,11 @@ public function reindex()
356369
}
357370

358371
/**
372+
* Get a list of custom attribute codes.
373+
*
359374
* {@inheritdoc}
375+
*
376+
* @return string[]
360377
* @since 100.0.6
361378
*/
362379
protected function getCustomAttributesCodes()
@@ -366,6 +383,7 @@ protected function getCustomAttributesCodes()
366383

367384
/**
368385
* Get new AttributeList dependency for application code.
386+
*
369387
* @return \Magento\Customer\Model\Address\CustomAttributeListInterface
370388
* @deprecated 100.0.6
371389
*/

app/code/Magento/Customer/Model/Customer.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1292,6 +1292,8 @@ public function getResetPasswordLinkExpirationPeriod()
12921292
}
12931293

12941294
/**
1295+
* Create Address from Factory
1296+
*
12951297
* @return Address
12961298
*/
12971299
protected function _createAddressInstance()
@@ -1300,6 +1302,8 @@ protected function _createAddressInstance()
13001302
}
13011303

13021304
/**
1305+
* Create Address Collection from Factory
1306+
*
13031307
* @return \Magento\Customer\Model\ResourceModel\Address\Collection
13041308
*/
13051309
protected function _createAddressCollection()
@@ -1308,6 +1312,8 @@ protected function _createAddressCollection()
13081312
}
13091313

13101314
/**
1315+
* Get Template Types
1316+
*
13111317
* @return array
13121318
*/
13131319
protected function getTemplateTypes()

app/code/Magento/Customer/Model/ResourceModel/CustomerRepository.php

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,14 @@ public function __construct(
161161
}
162162

163163
/**
164-
* {@inheritdoc}
164+
* Create or update a customer.
165+
*
166+
* @param \Magento\Customer\Api\Data\CustomerInterface $customer
167+
* @param string $passwordHash
168+
* @return \Magento\Customer\Api\Data\CustomerInterface
169+
* @throws \Magento\Framework\Exception\InputException If bad input is provided
170+
* @throws \Magento\Framework\Exception\State\InputMismatchException If the provided email is already used
171+
* @throws \Magento\Framework\Exception\LocalizedException
165172
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
166173
* @SuppressWarnings(PHPMD.NPathComplexity)
167174
*/
@@ -293,7 +300,13 @@ private function populateCustomerWithSecureData($customerModel, $passwordHash =
293300
}
294301

295302
/**
296-
* {@inheritdoc}
303+
* Retrieve customer.
304+
*
305+
* @param string $email
306+
* @param int|null $websiteId
307+
* @return \Magento\Customer\Api\Data\CustomerInterface
308+
* @throws \Magento\Framework\Exception\NoSuchEntityException If customer with the specified email does not exist.
309+
* @throws \Magento\Framework\Exception\LocalizedException
297310
*/
298311
public function get($email, $websiteId = null)
299312
{
@@ -302,7 +315,12 @@ public function get($email, $websiteId = null)
302315
}
303316

304317
/**
305-
* {@inheritdoc}
318+
* Get customer by Customer ID.
319+
*
320+
* @param int $customerId
321+
* @return \Magento\Customer\Api\Data\CustomerInterface
322+
* @throws \Magento\Framework\Exception\NoSuchEntityException If customer with the specified ID does not exist.
323+
* @throws \Magento\Framework\Exception\LocalizedException
306324
*/
307325
public function getById($customerId)
308326
{
@@ -311,7 +329,13 @@ public function getById($customerId)
311329
}
312330

313331
/**
332+
* Retrieve customers which match a specified criteria.
333+
*
314334
* {@inheritdoc}
335+
*
336+
* @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
337+
* @return \Magento\Customer\Api\Data\CustomerSearchResultsInterface
338+
* @throws \Magento\Framework\Exception\LocalizedException
315339
*/
316340
public function getList(SearchCriteriaInterface $searchCriteria)
317341
{
@@ -351,15 +375,24 @@ public function getList(SearchCriteriaInterface $searchCriteria)
351375
}
352376

353377
/**
354-
* {@inheritdoc}
378+
* Delete customer.
379+
*
380+
* @param \Magento\Customer\Api\Data\CustomerInterface $customer
381+
* @return bool true on success
382+
* @throws \Magento\Framework\Exception\LocalizedException
355383
*/
356384
public function delete(CustomerInterface $customer)
357385
{
358386
return $this->deleteById($customer->getId());
359387
}
360388

361389
/**
362-
* {@inheritdoc}
390+
* Delete customer by Customer ID.
391+
*
392+
* @param int $customerId
393+
* @return bool true on success
394+
* @throws \Magento\Framework\Exception\NoSuchEntityException
395+
* @throws \Magento\Framework\Exception\LocalizedException
363396
*/
364397
public function deleteById($customerId)
365398
{

0 commit comments

Comments
 (0)