--- title: phpDocumentor in Magento 2 description: PHPDoc is open source documentation generator written in PHP language. It automatically parses PHP source code and generates readable API and documents, which enables us to provide insights of source code. --- [![e-Zest logo\_An accion lab company\_Colour](https://blog.e-zest.com/hubfs/images/Logos%20with%20Tagline/Corporate/SVG/e-Zest%20logo_An%20accion%20lab%20company_Colour.svg "e-Zest logo_An accion lab company_Colour")](https://www.e-zest.com/) - [WORK](https://www.e-zest.com/our-work) - [SERVICES](https://www.e-zest.com/our-services) - [Product Engineering](https://www.e-zest.com/digital-product-engineering-services) - [Enterprise Data Services](https://www.e-zest.com/enterprise-data-services) - [Digital Commerce](https://www.e-zest.com/digital-commerce-services) - [Digital Operations](https://www.e-zest.com/digital-operations) - [Digital Consulting](https://www.e-zest.com/digital-transformation-consulting-services) - [Digital Experience Design](https://www.e-zest.com/digital-experience-design) - [INSIGHTS](https://blog.e-zest.com/) - [CAREERS](https://www.e-zest.com/careers) - [ENTERPRISE DATA SERVICES](https://www.e-zest.com/enterprise-data-services) - [GENERATIVE AI](https://www.e-zest.com/generative-ai) - [Healthcare](https://healthcare.e-zest.com) - [Contact Us](https://www.e-zest.com/contact-us) - ![Elevating Product Engineering with AI and ML](https://blog.e-zest.com/hubfs/Elevating%20Product%20Engineering%20with%20AI%20and%20ML.jpg) [BLOGS](https://blog.e-zest.com) #### Elevating Product Engineering with AI and ML As technology evolves and customer choices broaden, there is an increasing ... [Read more](https://blog.e-zest.com/elevating-product-engineering-with-ai-and-ml) - ![e-Zest – An Accion Labs Company gets Recognition as a Contender in the ISG Provider Lens™ Study on Digital Engineering Services 2024](https://blog.e-zest.com/hubfs/e-Zest%20%E2%80%93%20An%20Accion%20Labs%20Company%20-%20Gets%20Recognition%20as%20a%20Contender%20in%20the%20ISG%20Provider%20LensTM%20Study%20on%20Digital%20Engineering%20Services%202024.jpg) [NEWS](https://blog.e-zest.com/news) #### e-Zest – An Accion Labs Company gets Recognition as a Contender in the ISG Provider Lens™ Study on Digital Engineering Services 2024 We are delighted to announce that e-Zest – An Accion Labs Company has been ... [Read more](https://blog.e-zest.com/news/e-zest-an-accion-labs-company-gets-recognition-as-a-contender-in-the-isg-provider-lens-study-on-digital-engineering-services-2024) - ![e-Zest Solutions supports Digital Pune Mission](https://blog.e-zest.com/hubfs/blog-files/Digital%20Literacy%20Bus%20e-Zest.png) [CSR](https://blog.e-zest.com/csr) #### e-Zest Solutions supports Digital Pune Mission **Pune, India:** e-Zest Solutions, a leading digital technology innovation ... [Read more](https://blog.e-zest.com/csr/e-zest-solutions-supports-digital-pune-mission) - [Work](https://www.e-zest.com/our-work) - [Services](https://www.e-zest.com/our-services) - [Insights](https://blog.e-zest.com) - [Careers](https://www.e-zest.com/careers) - [Enterprise Data](https://www.e-zest.com/enterprise-data-services) - [Generative AI](https://www.e-zest.com/generative-ai) - [Innovations](https://www.e-zest.com/innovations) - [Healthcare](https://healthcare.e-zest.com) - [About](https://www.e-zest.com/about-us) - [Contact](https://www.e-zest.com/contact-us) - [Blog](https://blog.e-zest.com/) - [News](https://blog.e-zest.com/news) - [CSR](https://blog.e-zest.com/csr) - [![Linkedin Icon](https://blog.e-zest.com/hubfs/icons/linkedin_icon_white.svg)](https://www.linkedin.com/company/e-zest-solutions/) - [![Twitter Icon](https://blog.e-zest.com/hubfs/twitter-logo-silhouette%20(5).svg)](https://twitter.com/ezest) - [![Facebook Icon](https://blog.e-zest.com/hubfs/facebook-app-logo%20(4).svg)](https://www.facebook.com/61259256638) - [![Instagram Icon](https://blog.e-zest.com/hubfs/instagram-logo%20(4).svg)](https://www.instagram.com/ezestsolutions/) - [![Youtube Icon](https://blog.e-zest.com/hubfs/icons/youtube_icon_white.svg)](https://www.youtube.com/user/ezestcorporate) [![Go to top icon](https://blog.e-zest.com/hubfs/AA%20Assets/top%20button.svg)](https://blog.e-zest.com/php-documentor-in-magento-2#top) Hit enter to search or ESC to close Insights e-Zest members share technology ideas to foster digital transformation. - [Blog](https://blog.e-zest.com) - [Whitepaper](https://blog.e-zest.com/whitepaper) - [Playbook](https://blog.e-zest.com/playbook) - [News](https://blog.e-zest.com/news) - [Innovation](https://blog.e-zest.com/innovation) - [Media Kit](https://www.e-zest.com/media-kit) # phpDocumentor in Magento 2 [Darshan Khatri](https://blog.e-zest.com/author/darshan-khatri) Sep 18, 2018 [Magento 2.0](https://blog.e-zest.com/topic/magento-2-0) [For Developers](https://blog.e-zest.com/topic/for-developers) [phpDocumentor](https://blog.e-zest.com/topic/phpdocumentor) - - - - **What is phpDocumentor?** PHPDoc is open source documentation generator written in PHP language. It automatically parses PHP source code and generates readable API and documents, which enables us to provide insights of source code. **Installing on linux** 1\. System requirements - PHP 5.3.3 - intl extension for PHP - Graphviz [Click here](http://graphviz.org/Download..php) to download Graphviz 2\. Using PHAR - You can download PHAR file by [clicking here](http://phpdoc.org/phpDocumentor.phar). - After the download, move it to /usr/local/bin and rename it to “phpdoc”. - Now use command “phpdoc --version”. You will be able to see the result. phpDocumentor version v2.9.0 After successfully installing, you can generate phpDoc for any of your projects. In order to generate phpDoc, you need to run this command in the terminal: phpdoc -d “path/to/your/project/folder” -t “path/to/phpdoc/output” --template="responsive-twig" --title="Ezest Sample Project" There are different types of templates available in phpDoc. - check style - clean - responsive-twig Below is the output of above command. ![sample-project](https://blog.e-zest.com/hs-fs/hubfs/sample-project.png?width=659&name=sample-project.png) Click on “Errors” to see all the errors related to individual class files. ![sample-project-1](https://blog.e-zest.com/hs-fs/hubfs/sample-project-1.png?width=659&name=sample-project-1.png) Hope this helps you to implement phpDoc in your project. - - - ### Similar Blog [![How to setup Docker Container for Magento 2](https://blog.e-zest.com/hubfs/How%20to%20setup%20Docker%20Container%20for%20Magento%202.jpg) How to setup Docker Container for Magento 2 Docker is an application that allows us to manage multiple applications in the simplest way in the docker container. Docker ... By Rajesh Rathod Oct 15, 2021](https://blog.e-zest.com/how-to-setup-docker-container-for-magento2) [![Magento 2: Module Code Generation with Pestle](https://blog.e-zest.com/hubfs/blog-files/Magento%202%20%20Module%20code%20generation%20with%20Pestle.png) Magento 2: Module Code Generation with Pestle **What is Pestle?**The Pestle is a new PHP (5.6+) framework for creating and organizing PHP programs into Python like libraries of ... By Makarand Uparwat Nov 20, 2018](https://blog.e-zest.com/magento-2-module-code-generation-with-pestle) [Custom Sessions in Magento 2 Sessions play an important role in enhancing the user experience and they also help gather vital stats about the user visits. In ... By Pooja Pardeshi Nov 15, 2018](https://blog.e-zest.com/custom-sessions-in-magento-2) [![Magento 2 - How to display CMS block in Checkout Sidebar](https://blog.e-zest.com/hubfs/how-to-display-cms-block-in-checkout-sidebar.png) Magento 2 - How to display CMS block in Checkout Sidebar Using CMS blocks, site administrator can easily manipulate content of the vendor. CMS blocks can be used to display promotional ... By Sejal Shah Nov 01, 2018](https://blog.e-zest.com/magento-2-how-to-display-cms-block-in-checkout-sidebar) [![Code validations using static-review library in Magento](https://blog.e-zest.com/hubfs/code-validations-using-static-review-library-in-magento.png) Code validations using static-review library in Magento **Introduction:**Magento2 comes up with some advance tools and plugins, which are really useful for developers to track some common ... By Shubh Sharma Oct 19, 2018](https://blog.e-zest.com/code-validations-using-static-review-library-in-magento) ## Helping Organizations Thrive in the Digital Age [Contact Us](https://www.e-zest.com/contact-us) - [About](https://www.e-zest.com/about-us) - [Services](https://www.e-zest.com/our-services) - [Work](https://www.e-zest.com/our-work) - [Insights](https://blog.e-zest.com/) - [Healthcare](https://healthcare.e-zest.com/) - [Accion Labs](https://www.accionlabs.com/) - - - - - - Dallas - Detroit - Hannover - Vienna - London - Pune © 2025 e-Zest Solutions - [Privacy Policy](https://www.e-zest.com/privacypolicy) - [Cookie Policy](https://www.e-zest.com/cookie-policy) Contact us Contact us e-Zest is a leading digital innovation partner for enterprises and technology companies that utilizes emerging technologies for creating engaging customers experiences. Being a customer-focused and technology-driven company, it always helps clients in crafting holistic business value for their software development efforts. It offers software development and consulting services for cloud computing, enterprise mobility, big data and analytics, user experience and digital commerce.