PHP Documentor

1,861 views

Published on

Arunima - PHP Documentor

Published in: Technology
0 Comments
1 Like
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
1,861
On SlideShare
0
From Embeds
0
Number of Embeds
37
Actions
Shares
0
Downloads
85
Comments
0
Likes
1
Embeds 0
No embeds

No notes for slide

PHP Documentor

  1. 1. THE PHP DOCUMENTOR Presented by : - Arunima Goswami
  2. 2. INDEX <ul><li>What & Why of Documentation ? </li></ul><ul><li>What , Why and How of PHP Documenter ? </li></ul><ul><li>Example </li></ul>
  3. 3. Documentation : A bird’s viewpoint <ul><li>WHY </li></ul><ul><li>Now a standard </li></ul><ul><li>Required in teams </li></ul><ul><li>Assisting new team members </li></ul><ul><li>Display how code is designed </li></ul><ul><li>WHY NOT </li></ul><ul><li>Grueling process </li></ul><ul><li>Time consuming </li></ul>
  4. 4. What Is Documentation ? <ul><li>Recording in a particular format information that describes the code/product. </li></ul><ul><li>Documentation is often divided into the following categories: </li></ul><ul><ul><li>Installation </li></ul></ul><ul><ul><li>Reference </li></ul></ul><ul><ul><li>tutorial </li></ul></ul>
  5. 5. WHAT DOES ONE WANT ? <ul><li>End User </li></ul><ul><li>Instruction-style writing  </li></ul><ul><li>Interface information only </li></ul><ul><li>Examples and tutorials </li></ul><ul><li>Developer </li></ul><ul><li>How program elements interact </li></ul><ul><li>Where action occurs </li></ul><ul><li>How to extend the code </li></ul>
  6. 6. What is PHP Documenter ? <ul><li>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. </li></ul>
  7. 7. WHY ? <ul><li>output in HTML, PDF (directly), CHM (with windows help compiler), XML DocBook </li></ul><ul><li>very fast </li></ul><ul><li>fully customizable output with Smarty-based templates </li></ul><ul><li>recognizes JavaDoc-style documentation with special tags customized for PHP 4 </li></ul><ul><li>automatic linking, class inheritance diagrams and intelligent override </li></ul>
  8. 8. Cont’d … <ul><li>customizable source code highlighting </li></ul><ul><li>parses standard README/CHANGELOG/INSTALL/FAQ files and includes them directly in documentation </li></ul><ul><li>linking between external manual and API documentation is possible at the sub-section level in all output formats </li></ul><ul><li>user .ini files can be used to control output, multiple outputs can be generated at once </li></ul>
  9. 9. Installation <ul><li>Download from Pear.Php.net or Sourceforge.net </li></ul><ul><li>Have Apache and PHP installed </li></ul><ul><li>If using pear then simply run: </li></ul><ul><li>$ pear install PhpDocumentor </li></ul><ul><li>you can then browse to http://localhost/pear/PhpDocumentor to have access to the web interface. </li></ul><ul><li>Else you can use third party tools such as ZEND studio which has php documenter in it </li></ul>
  10. 10. EXAMPLE
  11. 11. THANK YOU

×