[solved]How to document dynamic behaviour of Prestashop

[Pierre_d]

I've created a custom product search provider for Prestashop 1.7. To achieve this, I had to dig into the heart of the code and understand how it works.

I have tons of paper notes and diagrams showing what method calls what classes->method overridden by this otherclass->method, passing parameters...

My question is: what would be the best way to document this. I'm sure there is some nice UML diagrams that would perfectly do the job and make all this readable. I would appreciate if someone can point me to the right direction or even provide some examples.

My goal would be to document what I've done and share it with the community.

By the way, you can see this search provider in action. Have a look at my webshop (test version for the moment).
Click on "Browse Tractors" and see how the products are filtered based on the tractor model.
https://www.prestashop.com/forums/topic/635917-new-webshop-spare-parts-for-john-deere-tractors

 

Edited December 1, 2017 by Pierre_d (see edit history)

[Pierre_d]

OK, nobody has shown interest yet but I found the answer to my question.

To document the static view of classes, use a UML class diagram.

To document the dynamic behavior of a portion of code, use UML sequence diagram.

 

example_prestashop_sequence_diagram.pdf

example_prestashop_classs_diagram.pdf

Edited December 1, 2017 by Pierre_d
Forgot attachments (see edit history)

[hydromel2008]

On 12/1/2017 at 6:15 AM, Pierre_d said:

OK, nobody has shown interest yet but I found the answer to my question.

To document the static view of classes, use a UML class diagram.

To document the dynamic behavior of a portion of code, use UML sequence diagram.

 

example_prestashop_sequence_diagram.pdf

example_prestashop_classs_diagram.pdf

Hello, a year and half late on the thread. I'm facing the very same problem. 

What did you use to generate uml schema of classes ?