Package home | Report new bug | New search | Development Roadmap Status: Open | Feedback | All | Closed Since Version 1.5.0a1

Request #12236 Allow RIC files in all directory
Submitted: 2007-10-12 21:38 UTC
From: yunosh Assigned: ashnazg
Status: Closed Package: PhpDocumentor (version 1.4.0)
PHP Version: Irrelevant OS:
Roadmaps: 1.5.0a1    

 [2007-10-12 21:38 UTC] yunosh (Jan Schneider)
Description: ------------ The attached patch allows to parse and include RIC files from any directory. The -ric parameter still takes a list of file (base) names, but all files in all parsed directories that match the name are included. To distinguish files with the same name in different directories, the subdirectory relative to the base directory is prefixed. The patch was only tested on Linux but should work on Windows too. The patch is unobtrusive, i.e. it doesn't change anything for existing projects that have all their RIC files in the base directory. Thus I would appreciate if it could be applied for 1.4.1 and doesn't have to wait for 1.5.0.


 [2007-12-08 03:58 UTC] ashnazg (Chuck Burgess)
Am testing this now... I expect, though, that I won't be able to get this into 1.4.1 unless I can extend the same capability into the other converters that Jan did not already patch.
 [2007-12-09 00:50 UTC] ashnazg (Chuck Burgess)
The patches seem to test ok, in that I do see the additional subdir'd RIC files shown on the left-side menu (tested using HTML:Smarty:HandS). Haven't done full regression testing across my three platforms yet. However, this capability will require more "default" control, in that by default there should not be any subdir'd RIC files picked up... any desired subdir RICs should be explicitly specified by the -ric argument. That will allow normal default behavior to remain unchanged, rather than people's doc gens to suddenly have additional RICs they didn't intend to show. At first I had thought perhaps there needed to be a way to control which Package view contained the subdir'd RICs, but the method above may help avoid that need altogether... not to mention I couldn't think of a good way to tie a RIC file to an actual Package. I don't think I can get these changes developed quick enough myself to make 1.4.1 :(
 [2007-12-09 15:51 UTC] yunosh (Jan Schneider)
I personally think that it makes much more sense to include all RIC files in all scanned directories by default. And if some doc files suddenly appear in some API docs, I expect the users to be positively surprised, rather than annoyed. But of course it's your choice whether you want this by default or not.
 [2012-09-01 02:24 UTC] ashnazg (Chuck Burgess)
-Status: Open +Status: Wont fix -Assigned To: +Assigned To: ashnazg -Roadmap Versions: 1.5.0a1 +Roadmap Versions:
No more feature work on phpDocumentor 1.x. Check out the new phpDocumentor 2.x (
 [2012-09-02 02:16 UTC] ashnazg (Chuck Burgess)
-Status: Wont fix +Status: Closed -Roadmap Versions: +Roadmap Versions: 1.5.0a1
Patch will be included in 1.5.0a1.