26 Sep 2008
Every branch of Zoop should contain one @mainpage docblock. This docblock is currently found in zoop.php, and looks something like this:
/**
* @mainpage Welcome to the Zoop Framework
*
* Welcome to the Zoop Framework. Newcomers to Zoop should check out
* {@link http://zoopframework.com/docs/from-a-to-zoop From A to Zoop},
* a beginner's guide to Zoop.
*
* - {@link http://zoopframework.com/docs Zoop Documentation}
* - {@link http://zoopframework.com/docs/from-a-to-zoop From A to Zoop}
* - {@link http://zoopframework.com/docs/user-manual The Zoop Users Manual}
* - {@link http://zoopframework.com/docs/cookbook The Zoop Cookbook}
* - {@link http://zoopframework.com/docs/user-manual/components Zoop Components}
* - App
* - Auth
* - Cache
* - Chart
*
* ...
*/The @mainpage docblock is used as the landing page for the branch at api.zoopframework.com. You may also define sections, subsections and subsubsections to break up more complex documentation pages:
/**
* @section sectionName Section Title
* ...
*
* @subsection subSectionName Subsection Title
* ...
*
* @subsubsection subSubSectionName Subsection Title
* ...
*
*/