Changes between Version 6 and Version 7 of PhpdocPlugin
- Timestamp:
- Dec 16, 2015, 3:57:17 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
PhpdocPlugin
v6 v7 54 54 55 55 A `[phpdoc]` section should be created in TracIni. 56 There's only one mandatory setting, it's the `path` to the generated documentation. 57 This should match the [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.target -t] parameter of the phpdoc command (if that's a relative path, you'll need to prepend the current working directory used 58 when running `phpdoc`). Also, don't forget to grant the users the PHPDOC_VIEW permission, or you'll just get a blank page. 56 There is only one mandatory setting, it is the `path` to the generated documentation. 57 This should match the [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.target -t] parameter of the phpdoc command. If that is a relative path, you'll need to prepend the current working directory used 58 when running `phpdoc`. 59 60 Also, don't forget to grant the users the PHPDOC_VIEW permission, or you'll just get a blank page. 59 61 60 62 Note that there's also the [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.output -o] 61 parameter which might play a role here. I got best results with the value 'HTML:Smarty:PHP' 63 parameter which might play a role here. I got best results with the value 'HTML:Smarty:PHP'. 62 64 63 65 == Example … … 83 85 }}} 84 86 85 The next time, you only need to run "svn up" in stead of "svn co" and runphpdoc again with the same parameters.87 The next time, you only need to run "svn up" instead of "svn co" and run phpdoc again with the same parameters. 86 88 87 It's possible all other options (configuration options multiple documentation projects, links in wiki) will work also, just like the ones specified with DoxygenPlugin, but I can't garranty anything.89 It's possible all other options (configuration options multiple documentation projects, links in wiki) will work also, just like the ones specified with DoxygenPlugin, but there are no guarantees. 88 90 On a first view, it appears to work good enough for me with this source and configuration. 89 91 90 92 '''Note''': If you install the plugin globally, you'll also need to enable it in trac.ini as follows: 91 92 93 {{{#!ini 93 94 [components]