Changeset 25154
- Timestamp:
- 12/09/09 23:12:18 (3 years ago)
- Files:
-
- plugins/sfDoxygenPlugin/trunk/README (modified) (3 diffs)
- plugins/sfDoxygenPlugin/trunk/config/exclude.txt (modified) (1 diff)
- plugins/sfDoxygenPlugin/trunk/data/skeleton/module/module/actions/actions.class.php (modified) (1 diff)
- plugins/sfDoxygenPlugin/trunk/package.xml (modified) (4 diffs)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
plugins/sfDoxygenPlugin/trunk/README
r25099 r25154 41 41 42 42 * Execute the tasks bundled with the plugin in the order specified below. 43 The first command creates file structure in _config/doxygen_ directory 43 The first command creates file structure in _config/doxygen_ directory 44 and copies modified version of module skeleton into base data directory. 44 45 (use this task only once otherwise the changes you made will be lost): 45 46 … … 61 62 62 63 * Additionally you may check the version of doxygen installed using command: 63 64 64 65 $ ./symfony doxygen:version 66 67 Module skeleton 68 --------------- 69 70 Running command _doxygen:init_ creates a subdirectory containing alternative 71 skeleton for module generation. The skeleton is stored in _data/skeleton/module_ 72 directory. The changes are only about the documentation code syntax, which 73 should be configured specially for doxygen (there are tiny differences between 74 PHPDoc and Doxygen). When a new module is generated within command: 75 76 $ ./symfony generate:module app mod 77 78 the framework already uses the new skeleton. This means that if you install 79 the plugin and run _doxygen:init_ command before generating any modules, all 80 generated modules will have doxygen-documentation-like comments without any 81 manual modifications. 82 83 By default the __@subpackage__ option is out and it is replaced with 84 __@class__. Of course, the best solution is to define your own skeleton 85 (if you have any suggestions, don't hesitate to mail me). 65 86 66 87 Documentation … … 71 92 migration classes, vendor). Moreover, action classes should be included (but 72 93 their templates are set to be excluded). 73 74 94 75 95 Notes plugins/sfDoxygenPlugin/trunk/config/exclude.txt
r25012 r25154 1 1 cache 2 2 data/symfony 3 data/skeleton 3 4 lib/vendor 4 5 lib/migration plugins/sfDoxygenPlugin/trunk/data/skeleton/module/module/actions/actions.class.php
r25059 r25154 10 10 * 11 11 * @package ##PROJECT_NAME## 12 * @class ##MODULE_NAME## 12 * @class ##MODULE_NAME##Actions 13 13 * @author ##AUTHOR_NAME## 14 14 * @version SVN: $Id: actions.class.php plugins/sfDoxygenPlugin/trunk/package.xml
r25099 r25154 11 11 <active>yes</active> 12 12 </lead> 13 <date>2009-12-0 8</date>13 <date>2009-12-09</date> 14 14 <time>11:00:00</time> 15 15 <version> 16 16 <release>1.0.4</release> 17 <api>1. 0.0</api>17 <api>1.2.0</api> 18 18 </version> 19 19 <stability> … … 32 32 <file role="data" name="exclude.txt" /> 33 33 <file role="data" name="exclude_patterns.txt" /> 34 </dir> 35 36 <dir name="data"> 37 <dir name="skeleton"> 38 <dir name="module"> 39 <dir name="module"> 40 <dir name="actions"> 41 <file role="data" name="actions.class.php" /> 42 </dir> 43 <dir name="templates"> 44 <file role="data" name="indexSuccess.php" /> 45 </dir> 46 </dir> 47 <dir name="test"> 48 <file role="data" name="actionsTest.php" /> 49 </dir> 50 </dir> 51 </dir> 34 52 </dir> 35 53 … … 69 87 70 88 <changelog> 71 89 72 90 <release> 73 91 <version> … … 80 98 </stability> 81 99 <license uri="http://www.symfony-project.org/license">MIT license</license> 82 <date>2009-12-0 7</date>100 <date>2009-12-09</date> 83 101 <license>MIT</license> 84 102 <notes> 85 103 * added module skeleton overriding 86 * moved all EXCLUDE base directories to EXCLUDE_PATTERNS (and excluded plugin model base classes)104 * moved all EXCLUDE model/base directories to EXCLUDE_PATTERNS (and excluded plugin model base classes) 87 105 * removed apps from EXCLUDE (mistake fixed) 88 106 * more code documentation
