Changes between Version 6 and Version 7 of PhpdocPlugin


Ignore:
Timestamp:
Dec 16, 2015, 3:57:17 PM (7 years ago)
Author:
figaro
Comment:

Replacement of " with double quotes, tagged with license

Legend:

Unmodified
Added
Removed
Modified
  • PhpdocPlugin

    v6 v7  
    5454
    5555A `[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.
     56There is only one mandatory setting, it is the `path` to the generated documentation.
     57This 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
     58when running `phpdoc`.
     59
     60Also, don't forget to grant the users the PHPDOC_VIEW permission, or you'll just get a blank page.
    5961
    6062Note 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'
     63parameter which might play a role here. I got best results with the value 'HTML:Smarty:PHP'.
    6264
    6365== Example
     
    8385}}}
    8486
    85 The next time, you only need to run "svn up" in stead of "svn co" and runphpdoc again with the same parameters.
     87The next time, you only need to run "svn up" instead of "svn co" and run phpdoc again with the same parameters.
    8688
    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.
     89It'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.
    8890On a first view, it appears to work good enough for me with this source and configuration.
    8991
    9092'''Note''': If you install the plugin globally, you'll also need to enable it in trac.ini as follows:
    91 
    9293{{{#!ini
    9394[components]