Text of pear.php.net › manual › en › developers.documentation.php as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout.

Open the live page

Manual :: Documentation

Register Login Main Support Documentation Packages Package Proposals Developers Bugs About PEAR Manual FAQ How to support the PEAR community (P r evious) Obtaining the manual sources (Ne x t) PEAR Manual PEAR Developer Guide Introduction Meaning for developers Contributing code to PEAR package.xml 2.0 Releasing A Package Supporting PEAR development Documentation package.xml Documentation Table of Contents Obtaining the manual sources Rendering the manual Docbook XML Writing documentation Translating PEAR's documentation Questions?

Documentation is a critical part of PEAR. Even the most interesting and helpful package will not be used without proper documentation that helps users understand it. Documentation for a package in PEAR means two things: API documentation that explains all classes, methods and functions a package provides Chapters and paragraphs about the package itself: What the package can be used for, how to use it, and examples. API documentation is automatically generated after a package has been released on pear.php.net from the code using phpDocumentor.

The second type of documentation needs to be created manually. It is the documentation you see in this very manual below the packages book. At first you will learn how to obtain and render this manual before going into detail about writing documentation for your own package. How to support the PEAR community (P r evious) Obtaining the manual sources (Ne x t) Last updated: Sat, 16 Feb 2019 — Download Documentation Do you think that something on this page is wrong?

Please file a bug report . View this page in: English User Notes: Note by: cweiske 2008-05-13 06:32 UTC peardoc entities checker: http://doc.php.net/pear/checkent.php PRIVACY POLICY | CREDITS Copyright © 2001-2026 The PHP Group All rights reserved. Bandwidth and hardware provided by: eUKhost