logging in or signing up Php Documentor By Arunima Goswami OSSCube Download Post to : URL : Related Presentations : Share Add to Flag Embed Email Send to Blogs and Networks Add to Channel Uploaded from authorPOINT lite Insert YouTube videos in PowerPont slides with aS Desktop Copy embed code: (To copy code, click on the text box) Embed: URL: Thumbnail: WordPress Embed Customize Embed The presentation is successfully added In Your Favorites. Views: 72 Category: Entertainment License: All Rights Reserved Like it (0) Dislike it (0) Added: April 17, 2009 This Presentation is Public Favorites: 0 Presentation Description Arunima Goswami presents on Php documentor at OSSCamp, organized by OSSCube. To know how we can help your business grow, leveraging Open Source, contact us: India: +91 995 809 0987 USA: +1 919 791 5427 WEB: www.osscube.com Mail: sales@osscube.co Comments Posting comment... Premium member Presentation Transcript THE PHP DOCUMENTOR : THE PHP DOCUMENTOR OSScamp, Impetus Noida, Sept, ’07 Arunima Goswami Technical Sales Manager, OSSCube INDEX : INDEX What & Why of Documentation ? What , Why and How of PHP Documenter? Example Documentation : A bird’s viewpoint : Documentation : A bird’s viewpoint WHY Now a standard Required in teams Assisting new team members Display how code is designed WHY NOT Grueling process Time consuming What Is Documentation ? : What Is Documentation ? Recording in a particular format information that describes the code/product. Documentation is often divided into the following categories: Installation Reference Tutorial WHAT DOES ONE WANT ? : WHAT DOES ONE WANT ? End User Instruction-style writing Interface information only Examples and tutorials Developer How program elements interact Where action occurs How to extend the code What is PHP Documenter ? : What is PHP Documenter ? A PHP code document generation tool which is a stand-alone professional documenter that is written in PHP designed to easily and efficiently generate PHP code documents in HTML from PHP project source code and/or external documentation. WHY ? : WHY ? Output in HTML, PDF (directly), CHM (with windows help compiler), XML DocBook Very fast Fully customizable output with Smarty-based templates Recognizes JavaDoc-style documentation with special tags customized for PHP 4 Automatic linking, class inheritance diagrams and intelligent override Cont’d … : Cont’d … Customizable source code highlighting Parses standard README/CHANGELOG/INSTALL/FAQ files and includes them directly in documentation Linking between external manual and API documentation is possible at the sub-section level in all output formats user.ini files can be used to control output, multiple outputs can be generated at once Installation : Installation Download from Pear.Php.net or Sourceforge.net Have Apache and PHP installed If using pear then simply run: $ pear install PhpDocumentor You can then browse to http://localhost/pear/PhpDocumentor to have access to the web interface. Else you can use third party tools such as ZEND studio which has php documenter in it EXAMPLE : EXAMPLE Thank you! : For more information, contact us: OSSCube India: +91 995 809 0987 USA: +1 919 791 5427 Web: www.osscube.com Mail: info@osscube.com Thank you! You do not have the permission to view this presentation. In order to view it, please contact the author of the presentation.
Php Documentor By Arunima Goswami OSSCube Download Post to : URL : Related Presentations : Share Add to Flag Embed Email Send to Blogs and Networks Add to Channel Uploaded from authorPOINT lite Insert YouTube videos in PowerPont slides with aS Desktop Copy embed code: (To copy code, click on the text box) Embed: URL: Thumbnail: WordPress Embed Customize Embed The presentation is successfully added In Your Favorites. Views: 72 Category: Entertainment License: All Rights Reserved Like it (0) Dislike it (0) Added: April 17, 2009 This Presentation is Public Favorites: 0 Presentation Description Arunima Goswami presents on Php documentor at OSSCamp, organized by OSSCube. To know how we can help your business grow, leveraging Open Source, contact us: India: +91 995 809 0987 USA: +1 919 791 5427 WEB: www.osscube.com Mail: sales@osscube.co Comments Posting comment... Premium member Presentation Transcript THE PHP DOCUMENTOR : THE PHP DOCUMENTOR OSScamp, Impetus Noida, Sept, ’07 Arunima Goswami Technical Sales Manager, OSSCube INDEX : INDEX What & Why of Documentation ? What , Why and How of PHP Documenter? Example Documentation : A bird’s viewpoint : Documentation : A bird’s viewpoint WHY Now a standard Required in teams Assisting new team members Display how code is designed WHY NOT Grueling process Time consuming What Is Documentation ? : What Is Documentation ? Recording in a particular format information that describes the code/product. Documentation is often divided into the following categories: Installation Reference Tutorial WHAT DOES ONE WANT ? : WHAT DOES ONE WANT ? End User Instruction-style writing Interface information only Examples and tutorials Developer How program elements interact Where action occurs How to extend the code What is PHP Documenter ? : What is PHP Documenter ? A PHP code document generation tool which is a stand-alone professional documenter that is written in PHP designed to easily and efficiently generate PHP code documents in HTML from PHP project source code and/or external documentation. WHY ? : WHY ? Output in HTML, PDF (directly), CHM (with windows help compiler), XML DocBook Very fast Fully customizable output with Smarty-based templates Recognizes JavaDoc-style documentation with special tags customized for PHP 4 Automatic linking, class inheritance diagrams and intelligent override Cont’d … : Cont’d … Customizable source code highlighting Parses standard README/CHANGELOG/INSTALL/FAQ files and includes them directly in documentation Linking between external manual and API documentation is possible at the sub-section level in all output formats user.ini files can be used to control output, multiple outputs can be generated at once Installation : Installation Download from Pear.Php.net or Sourceforge.net Have Apache and PHP installed If using pear then simply run: $ pear install PhpDocumentor You can then browse to http://localhost/pear/PhpDocumentor to have access to the web interface. Else you can use third party tools such as ZEND studio which has php documenter in it EXAMPLE : EXAMPLE Thank you! : For more information, contact us: OSSCube India: +91 995 809 0987 USA: +1 919 791 5427 Web: www.osscube.com Mail: info@osscube.com Thank you!