Prestashop: [BOOM-5384] API Documentation

[prestonBot]

This issue has been migrated from the Forge. Read the original ticket here.

• _Reporter:_ mrbig00
• _Created at:_ Fri, 20 Apr 2018 11:52:25 +0200

I'm constantly facing the issue that I have to figure out what methods do, return, etc.

And I was wondering that we could document more the code with the DocBlock format and from these we could generate some kind of documentation like other frameworks do. For example:

• symfony
• laravel
• yii
• and many more

I'm sure that I'm not alone with this frustration and I'm ready to contribute, but the codebase is huge and I can't do this alone. What's your opinion guys?

[prestonBot]

This comment has been migrated from the Forge. Read the original comment here.

• _Author:_ khouloud.belguith
• _Created at:_ Fri, 20 Apr 2018 12:14:51 +0200

Salut,

Que pensez-vous de sa remarque ?

Merci!

[marionf]

@PrestaShop/prestashop-core-developers is this request still up to date ?

[matks]

@marionf Indeed the PrestaShop API lacks a complete documentation, this issue is still true.

And I was wondering that we could document more the code with the DocBlock format and from these we could generate some kind of documentation like other frameworks do.

This could be a nice idea althought it could not be done by reading the code alone as the API definition can be modified by modules. However at runtime, for example in a BO page, we could provide such a documentation. This is a feature request.

[Alamgir67]

[prashantjain257]

test.