| Package home | Report new bug | New search | Development Roadmap | Status: Open | Feedback | All | Closed Since Version 1.5.0a1 |
| Doc Bug #11143 | Provide a Minimal Tutorial File Setup Example | ||
|---|---|---|---|
| Submitted: | 2007-05-25 17:55 UTC | ||
| From: | ashnazg | Assigned: | ashnazg |
| Status: | Closed | Package: | PhpDocumentor (version 1.4.0a1) |
| PHP Version: | Irrelevant | OS: | Irrelevant |
| Roadmaps: | 1.4.0a2 | ||
[2007-05-25 17:55 UTC] ashnazg
(Chuck Burgess)
Description:
------------
Provide an example of the most minimal file/dir setup needed for PhpDocumentor to recognize and process said file/dir setup at tutorial docs.
Looks to me like that mimimum would be:
DIR - PackageName/tutorials
DIR - PackageName/tutorials/PackageName
PKG - PackageName/tutorials/PackageName/PackageName.pkg
Comments
[2007-05-25 18:51 UTC] ashnazg
(Chuck Burgess)
Another "minimal setup requirement" for tutorials is that you do already have some files using the "@package PackageName" tags. That way PhpDocumentor can correlate the PKG file to the proper package document set.
[2007-05-31 00:49 UTC] ashnazg
(Chuck Burgess)
Here's the patch for tutorial.pkg that contains the minimal tutorial file contents example.