├── documentation
    └── docs.php
├── README.md
├── developer
    ├── globals.php
    ├── theme.php
    └── hooks
    │   ├── install.php
    │   └── node.php
└── config.doxy


/documentation/docs.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /**
 4 |  * @mainpage CHANGE ME (Project Title)
 5 |  *
 6 |  * This is an example main page. Change this text to your project description and links to other
 7 |  * relevant information.
 8 |  *
 9 |  * For more information on this project see http://github.com/mattfarina/drupal-doxygen-base
10 |  */


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Drupal Doxygen Generation
 2 | 
 3 | This package provides what is needed to generate project Doxygen documentation for a site or module.
 4 | 
 5 | To create Drupal 6 documentation, as opposed to that for a site or modules, see the [Drupal 6 Doxygen](http://github.com/mattfarina/drupal-6-doxygen) project.
 6 | 
 7 | ## Dependencies
 8 | 
 9 | [Doxygen](http://www.stack.nl/~dimitri/doxygen)
10 | 
11 | ## Generating Site Documentation
12 | 
13 | This method is for generating site documentation for a full site.
14 | 
15 |  * In the config.doxy file the PROJECT_NAME to the name of the project and PROJECT_NUMBER to the
16 |    version of the project.
17 |  * And the drupal site to the base directory of this project.
18 |  * In the file documentation/docs.php update the page title and description to that of the project.
19 |    Add additional pages as needed following the [Doxygen Commands](http://www.stack.nl/~dimitri/doxygen/commands.html) for the page tag.
20 |  * From the command line execute `doxygen config.doxy`. This will generate the documentation and put it in the new directory docs/html.
21 |  * Open up your browser to docs/html/index.html.
22 | 
23 | ## Generating Module Documentation
24 | 
25 | This method is for generating module documentation. 
26 | 
27 |  * In the config.doxy file the PROJECT_NAME to the name of the module and PROJECT_NUMBER to the
28 |    version of the module.
29 |  * And the module to the base directory of this project.
30 |  * Remove the developer directory. This directory holds the hook documentation for Drupal 6 and is not
31 |    needed for a module.
32 |  * In the file documentation/docs.php update the page title and description to that of the module.
33 |    Add additional pages as needed following the [Doxygen Commands](http://www.stack.nl/~dimitri/doxygen/commands.html) for the page tag.
34 |  * From the command line execute `doxygen config.doxy`. This will generate the documentation and put it in the new directory docs/html.
35 |  * Open up your browser to docs/html/index.html.
36 | 
37 | ## Custom Configs
38 | 
39 | Doxygen has a lot of configuration options. The ones chosen here are to my preference but you may want something different.
40 | 
41 | For more details on how to configure Doxygen you can read the commends in the config file or the [Online Documentation](http://www.stack.nl/~dimitri/doxygen/config.html)
42 | 


--------------------------------------------------------------------------------
/developer/globals.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | // $Id: globals.php,v 1.3.2.5 2009/11/10 16:07:52 jhodgdon Exp $
  3 | 
  4 | /**
  5 |  * @file
  6 |  * These are the global variables that Drupal uses.
  7 |  */
  8 | 
  9 | /**
 10 |  * Stores timers that have been created by timer_start().
 11 |  *
 12 |  * @see timer_start()
 13 |  * @see timer_read()
 14 |  * @see timer_stop()
 15 |  */
 16 | global $timers;
 17 | 
 18 | /**
 19 |  * The base URL of the drupal installation.
 20 |  *
 21 |  * @see conf_init()
 22 |  */
 23 | global $base_url;
 24 | 
 25 | /**
 26 |  * The base path of the drupal installation. At least will default to /.
 27 |  *
 28 |  * @see conf_init()
 29 |  */
 30 | global $base_path;
 31 | 
 32 | /**
 33 |  * The root URL of the host excludes the path.
 34 |  *
 35 |  * @see conf_init()
 36 |  */
 37 | global $base_root;
 38 | 
 39 | /**
 40 |  * The url of the database. Thorough documentation provided in default.settings.php.
 41 |  */
 42 | global $db_url;
 43 | 
 44 | /**
 45 |  * The prefix to be placed on all database tables.
 46 |  */
 47 | global $db_prefix;
 48 | 
 49 | /**
 50 |  * The domain to be used form session cookies.
 51 |  *
 52 |  * Cookie domains must contain at least one dot other than the first (RFC 2109).
 53 |  * For hosts such as 'localhost' or an IP Addresses the cookie domain will not be set.
 54 |  */
 55 | global $cookie_domain;
 56 | 
 57 | /**
 58 |  * Array of persistent variables stored in 'variable' table.
 59 |  * 
 60 |  * @see variable_get()
 61 |  * @see variable_set()
 62 |  * @see variable_del()
 63 |  */
 64 | global $conf;
 65 | 
 66 | /**
 67 |  * The name of the profile that has just been installed.
 68 |  */
 69 | global $installed_profile;
 70 | 
 71 | /**
 72 |  * Access control for update.php script. Allows the update.php script to be run when
 73 |  * not logged in as and administrator.
 74 |  */
 75 | global $update_free_access;
 76 | 
 77 | /**
 78 |  * Representation of the current user. Stores preferences and other user information.
 79 |  */
 80 | global $user;
 81 | 
 82 | /**
 83 |  * An object containing the information for the active language.
 84 |  *
 85 |  * Example values:
 86 |  *  - 'language' => 'en',
 87 |  *  - 'name' => 'English',
 88 |  *  - 'native' => 'English',
 89 |  *  - 'direction' => 0,
 90 |  *  - 'enabled' => 1,
 91 |  *  - 'plurals' => 0,
 92 |  *  - 'formula' => '',
 93 |  *  - 'domain' => '',
 94 |  *  - 'prefix' => '',
 95 |  *  - 'weight' => 0,
 96 |  *  - 'javascript' => '' 
 97 |  */
 98 | global $language;
 99 | 
100 | /**
101 |  * Disabled caling hook_boot() and hook_exit() during the update process (update.php) since
102 |  * the database is in a largely unknown state.
103 |  *
104 |  * @see drupal_goto()
105 |  */
106 | global $update_mode;
107 | 
108 | /**
109 |  * The name of the currently installed profile.
110 |  */
111 | global $profile;
112 | 
113 | /**
114 |  * The type of database being used.
115 |  *
116 |  * Example: mysql.
117 |  */
118 | global $db_type;
119 | 
120 | /**
121 |  * Active database connection.
122 |  *
123 |  * @see db_set_active()
124 |  */
125 | global $active_db;
126 | 
127 | /**
128 |  * Array of queries that have been executed.
129 |  */
130 | global $queries;
131 | 
132 | /**
133 |  * Resource of the query executed.
134 |  */
135 | global $last_result;
136 | 
137 | /**
138 |  * The locale to use during installation
139 |  *
140 |  * @see st()
141 |  */
142 | global $install_locale;
143 | 
144 | /**
145 |  * Result of pager_query() that is utilized by other functions.
146 |  */
147 | global $pager_page_array;
148 | 
149 | /**
150 |  * Array of the total number of pages per pager. The key is will be 0 by defualt, but
151 |  * can be specified via the $element parameter of pager_query().
152 |  */
153 | global $pager_total;
154 | 
155 | /**
156 |  * Array of the total number of items per pager. The key is will be 0 by defualt, but
157 |  * can be specified via the $element parameter of pager_query().
158 |  */
159 | global $pager_total_items;
160 | 
161 | /**
162 |  * Name of the active theme.
163 |  */
164 | global $theme;
165 | 
166 | /**
167 |  * Name of custom theme to override default theme.
168 |  *
169 |  * @see init_theme()
170 |  */
171 | global $custom_theme;
172 | 
173 | /**
174 |  * Name of the active theme.
175 |  *
176 |  * @see init_theme()
177 |  */
178 | global $theme_key;
179 | 
180 | /**
181 |  * Active theme object. For documentation of the theme object see _init_theme().
182 |  *
183 |  * @see _init_theme()
184 |  */
185 | global $theme_info;
186 | 
187 | /**
188 |  * An array of objects that reperesent the base theme. For documentation of the
189 |  * theme object see _init_theme().
190 |  *
191 |  * @see _init_theme()
192 |  */
193 | global $base_theme_info;
194 | 
195 | /**
196 |  * The active theme engine related to the active theme.
197 |  */
198 | global $theme_engine;
199 | 
200 | /**
201 |  * Path to the active theme.
202 |  */
203 | global $theme_path;
204 | 
205 | /**
206 |  * The current multibyte mode.
207 |  * Possible values: UNICODE_ERROR, UNICODE_SINGLEBYTE, UNICODE_MULTIBYTE.
208 |  */
209 | global $multibyte;
210 | 
211 | /**
212 |  * General string or array.
213 |  *
214 |  * @see aggregator_element_start()
215 |  */
216 | global $item;
217 | 
218 | /**
219 |  * Structured array describing the data to be rendered.
220 |  *
221 |  * @see aggregator_element_start()
222 |  */
223 | global $element;
224 | 
225 | /**
226 |  * Active tag name.
227 |  *
228 |  * @see aggregator_element_start()
229 |  */
230 | global $tag;
231 | 
232 | /**
233 |  * Array of items used by aggregator.
234 |  *
235 |  * @see aggregator_element_start()
236 |  */
237 | global $items;
238 | 
239 | /**
240 |  * An associative array containing title, link, description and other keys.
241 |  * The link should be an absolute URL.
242 |  *
243 |  * @see aggregator_element_start()
244 |  */
245 | global $channel;
246 | 
247 | /**
248 |  * Current image tag used by aggregator.
249 |  */
250 | global $image;
251 | 
252 | /**
253 |  * Active blog node id.
254 |  */
255 | global $nid;
256 | 
257 | /**
258 |  * An array of topic header information.
259 |  */
260 | global $forum_topic_list_header;
261 | 
262 | /**
263 |  * Boolean indicating that a menu administrator is running the menu access check.
264 |  */
265 | global $menu_admin;
266 | 
267 | /**
268 |  * Array used by XRDS XML parser for OpenID to track parsing state.
269 |  */
270 | global $xrds_services;
271 | 
272 | /**
273 |  * Array used by XRDS XML parser for OpenID to track parsing state.
274 |  */
275 | global $xrds_open_elements;
276 | 
277 | /**
278 |  * Array used by XRDS XML parser for OpenID to track parsing state.
279 |  */
280 | global $xrds_current_service;
281 | 
282 | /**
283 |  * Recent activity statistics generated by statistics_exit().
284 |  */
285 | global $recent_activity;
286 | 
287 | /**
288 |  * Active statistics record id.
289 |  */
290 | global $id;
291 | 


--------------------------------------------------------------------------------
/developer/theme.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | // $Id: theme.php,v 1.1.2.5 2010/07/02 01:04:44 drumm Exp $
  3 | 
  4 | /**
  5 |  * @file
  6 |  * Shadow theme functions for theme templates.
  7 |  *
  8 |  * The API module is currently being updated to allow template files to be
  9 |  * included in the themeable group.
 10 |  *   - Patch API module to allow "ingroup" in "file" docblocks. [#559166]
 11 |  *   - Deploy updated API module, API 6.x-1.3.
 12 |  *   - Add "themeable" to file docblocks of all templates. [#716496]
 13 |  *   - Backport [#716496] to Drupal 6.
 14 |  *
 15 |  * When this process has been completed, this theme.php file should be removed
 16 |  * from CVS.
 17 |  */
 18 | 
 19 | /**
 20 |  * @ingroup themeable
 21 |  * @{
 22 |  */
 23 | 
 24 | /**
 25 |  * Implemented using the aggregator-feed-source.tpl.php template.
 26 |  *
 27 |  * @see aggregator-feed-source.tpl.php
 28 |  */
 29 | function theme_aggregator_feed_source() {
 30 |   // This function is never used; see the corresponding template file instead.
 31 | }
 32 | 
 33 | /**
 34 |  * Implemented using the aggregator-item.tpl.php template.
 35 |  *
 36 |  * @see aggregator-item.tpl.php
 37 |  */
 38 | function theme_aggregator_item() {
 39 |   // This function is never used; see the corresponding template file instead.
 40 | }
 41 | 
 42 | /**
 43 |  * Implemented using the aggregator-summary-item.tpl.php template.
 44 |  *
 45 |  * @see aggregator-summary-item.tpl.php
 46 |  */
 47 | function theme_aggregator_summary_item() {
 48 |   // This function is never used; see the corresponding template file instead.
 49 | }
 50 | 
 51 | /**
 52 |  * Implemented using the aggregator-summary-items.tpl.php template.
 53 |  *
 54 |  * @see aggregator-summary-items.tpl.php
 55 |  */
 56 | function theme_aggregator_summary_items() {
 57 |   // This function is never used; see the corresponding template file instead.
 58 | }
 59 | 
 60 | /**
 61 |  * Implemented using the aggregator-wrapper.tpl.php template.
 62 |  *
 63 |  * @see aggregator-wrapper.tpl.php
 64 |  */
 65 | function theme_aggregator_wrapper() {
 66 |   // This function is never used; see the corresponding template file instead.
 67 | }
 68 | 
 69 | /**
 70 |  * Implemented using the block-admin-display-form.tpl.php template.
 71 |  *
 72 |  * @see block-admin-display-form.tpl.php
 73 |  */
 74 | function theme_block_admin_display_form() {
 75 |   // This function is never used; see the corresponding template file instead.
 76 | }
 77 | 
 78 | /**
 79 |  * Implemented using the book-all-books-block.tpl.php template.
 80 |  *
 81 |  * @see book-all-books-block.tpl.php
 82 |  */
 83 | function theme_book_all_books_block() {
 84 |   // This function is never used; see the corresponding template file instead.
 85 | }
 86 | 
 87 | /**
 88 |  * Implemented using the book-export-html.tpl.php template.
 89 |  *
 90 |  * @see book-export-html.tpl.php
 91 |  */
 92 | function theme_book_export_html() {
 93 |   // This function is never used; see the corresponding template file instead.
 94 | }
 95 | 
 96 | /**
 97 |  * Implemented using the book-navigation.tpl.php template.
 98 |  *
 99 |  * @see book-navigation.tpl.php
100 |  */
101 | function theme_book_navigation() {
102 |   // This function is never used; see the corresponding template file instead.
103 | }
104 | 
105 | /**
106 |  * Implemented using the book-node-export-html.tpl.php template.
107 |  *
108 |  * @see book-node-export-html.tpl.php
109 |  */
110 | function theme_book_node_export_html() {
111 |   // This function is never used; see the corresponding template file instead.
112 | }
113 | 
114 | /**
115 |  * Implemented using the comment-folded.tpl.php template.
116 |  *
117 |  * @see comment-folded.tpl.php
118 |  */
119 | function theme_comment_folded() {
120 |   // This function is never used; see the corresponding template file instead.
121 | }
122 | 
123 | /**
124 |  * Implemented using the comment-wrapper.tpl.php template.
125 |  *
126 |  * @see comment-wrapper.tpl.php
127 |  */
128 | function theme_comment_wrapper() {
129 |   // This function is never used; see the corresponding template file instead.
130 | }
131 | 
132 | /**
133 |  * Implemented using the comment.tpl.php template.
134 |  *
135 |  * @see comment.tpl.php
136 |  */
137 | function theme_comment() {
138 |   // This function is never used; see the corresponding template file instead.
139 | }
140 | 
141 | /**
142 |  * Implemented using the forum-icon.tpl.php template.
143 |  *
144 |  * @see forum-icon.tpl.php
145 |  */
146 | function theme_forum_icon() {
147 |   // This function is never used; see the corresponding template file instead.
148 | }
149 | 
150 | /**
151 |  * Implemented using the forum-list.tpl.php template.
152 |  *
153 |  * @see forum-list.tpl.php
154 |  */
155 | function theme_forum_list() {
156 |   // This function is never used; see the corresponding template file instead.
157 | }
158 | 
159 | /**
160 |  * Implemented using the forum-submitted.tpl.php template.
161 |  *
162 |  * @see forum-submitted.tpl.php
163 |  */
164 | function theme_forum_submitted() {
165 |   // This function is never used; see the corresponding template file instead.
166 | }
167 | 
168 | /**
169 |  * Implemented using the forum-topic-list.tpl.php template.
170 |  *
171 |  * @see forum-topic-list.tpl.php
172 |  */
173 | function theme_forum_topic_list() {
174 |   // This function is never used; see the corresponding template file instead.
175 | }
176 | 
177 | /**
178 |  * Implemented using the forum-topic-navigation.tpl.php template.
179 |  *
180 |  * @see forum-topic-navigation.tpl.php
181 |  */
182 | function theme_forum_topic_navigation() {
183 |   // This function is never used; see the corresponding template file instead.
184 | }
185 | 
186 | /**
187 |  * Implemented using the forums.tpl.php template.
188 |  *
189 |  * @see forums.tpl.php
190 |  */
191 | function theme_forums() {
192 |   // This function is never used; see the corresponding template file instead.
193 | }
194 | 
195 | /**
196 |  * Implemented using the node.tpl.php template.
197 |  *
198 |  * @see node.tpl.php
199 |  */
200 | function theme_node() {
201 |   // This function is never used; see the corresponding template file instead.
202 | }
203 | 
204 | /**
205 |  * Implemented using the poll-bar-block.tpl.php template.
206 |  *
207 |  * @see poll-bar-block.tpl.php
208 |  */
209 | function theme_poll_bar_block() {
210 |   // This function is never used; see the corresponding template file instead.
211 | }
212 | 
213 | /**
214 |  * Implemented using the poll-bar.tpl.php template.
215 |  *
216 |  * @see poll-bar.tpl.php
217 |  */
218 | function theme_poll_bar() {
219 |   // This function is never used; see the corresponding template file instead.
220 | }
221 | 
222 | /**
223 |  * Implemented using the poll-results-block.tpl.php template.
224 |  *
225 |  * @see poll-results-block.tpl.php
226 |  */
227 | function theme_poll_results_block() {
228 |   // This function is never used; see the corresponding template file instead.
229 | }
230 | 
231 | /**
232 |  * Implemented using the poll-results.tpl.php template.
233 |  *
234 |  * @see poll-results.tpl.php
235 |  */
236 | function theme_poll_results() {
237 |   // This function is never used; see the corresponding template file instead.
238 | }
239 | 
240 | /**
241 |  * Implemented using the poll-vote.tpl.php template.
242 |  *
243 |  * @see poll-vote.tpl.php
244 |  */
245 | function theme_poll_vote() {
246 |   // This function is never used; see the corresponding template file instead.
247 | }
248 | 
249 | /**
250 |  * Implemented using the profile-block.tpl.php template.
251 |  *
252 |  * @see profile-block.tpl.php
253 |  */
254 | function theme_profile_block() {
255 |   // This function is never used; see the corresponding template file instead.
256 | }
257 | 
258 | /**
259 |  * Implemented using the profile-listing.tpl.php template.
260 |  *
261 |  * @see profile-listing.tpl.php
262 |  */
263 | function theme_profile_listing() {
264 |   // This function is never used; see the corresponding template file instead.
265 | }
266 | 
267 | /**
268 |  * Implemented using the profile-wrapper.tpl.php template.
269 |  *
270 |  * @see profile-wrapper.tpl.php
271 |  */
272 | function theme_profile_wrapper() {
273 |   // This function is never used; see the corresponding template file instead.
274 | }
275 | 
276 | /**
277 |  * Implemented using the search-block-form.tpl.php template.
278 |  *
279 |  * @see search-block-form.tpl.php
280 |  */
281 | function theme_search_block_form() {
282 |   // This function is never used; see the corresponding template file instead.
283 | }
284 | 
285 | /**
286 |  * Implemented using the search-result.tpl.php template.
287 |  *
288 |  * @see search-result.tpl.php
289 |  */
290 | function theme_search_result() {
291 |   // This function is never used; see the corresponding template file instead.
292 | }
293 | 
294 | /**
295 |  * Implemented using the search-results.tpl.php template.
296 |  *
297 |  * @see search-results.tpl.php
298 |  */
299 | function theme_search_results() {
300 |   // This function is never used; see the corresponding template file instead.
301 | }
302 | 
303 | /**
304 |  * Implemented using the search-theme-form.tpl.php template.
305 |  *
306 |  * @see search-theme-form.tpl.php
307 |  */
308 | function theme_search_theme_form() {
309 |   // This function is never used; see the corresponding template file instead.
310 | }
311 | 
312 | /**
313 |  * Implemented using the block.tpl.php template.
314 |  *
315 |  * @see block.tpl.php
316 |  */
317 | function theme_block() {
318 |   // This function is never used; see the corresponding template file instead.
319 | }
320 | 
321 | /**
322 |  * Implemented using the maintenance-page.tpl.php template.
323 |  *
324 |  * @see maintenance-page.tpl.php
325 |  */
326 | function theme_maintenance_page() {
327 |   // This function is never used; see the corresponding template file instead.
328 | }
329 | 
330 | /**
331 |  * Implemented using the page.tpl.php template.
332 |  *
333 |  * @see page.tpl.php
334 |  */
335 | function theme_page() {
336 |   // This function is never used; see the corresponding template file instead.
337 | }
338 | 
339 | /**
340 |  * Implemented using the user-picture.tpl.php template.
341 |  *
342 |  * @see user-picture.tpl.php
343 |  */
344 | function theme_user_picture() {
345 |   // This function is never used; see the corresponding template file instead.
346 | }
347 | 
348 | /**
349 |  * Implemented using the user-profile-category.tpl.php template.
350 |  *
351 |  * @see user-profile-category.tpl.php
352 |  */
353 | function theme_user_profile_category() {
354 |   // This function is never used; see the corresponding template file instead.
355 | }
356 | 
357 | /**
358 |  * Implemented using the user-profile-item.tpl.php template.
359 |  *
360 |  * @see user-profile-item.tpl.php
361 |  */
362 | function theme_user_profile_item() {
363 |   // This function is never used; see the corresponding template file instead.
364 | }
365 | 
366 | /**
367 |  * Implemented using the user-profile.tpl.php template.
368 |  *
369 |  * @see user-profile.tpl.php
370 |  */
371 | function theme_user_profile() {
372 |   // This function is never used; see the corresponding template file instead.
373 | }
374 | 
375 | /**
376 |  * @} End of "ingroup themeable".
377 |  */
378 | 


--------------------------------------------------------------------------------
/developer/hooks/install.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | // $Id: install.php,v 1.14.2.11 2010/08/17 15:41:09 jhodgdon Exp $
  3 | 
  4 | /**
  5 |  * @file
  6 |  * Documentation for the installation and update system.
  7 |  *
  8 |  * The update system is used by modules to provide database updates which are
  9 |  * run with update.php.
 10 |  *
 11 |  * Implementations of these hooks should be placed in a mymodule.install file in
 12 |  * the same directory as mymodule.module.
 13 |  */
 14 | 
 15 | /**
 16 |  * @addtogroup hooks
 17 |  * @{
 18 |  */
 19 | 
 20 | /**
 21 |  * Check installation requirements and do status reporting.
 22 |  *
 23 |  * This hook has two closely related uses, determined by the $phase argument:
 24 |  * checking installation requirements ($phase == 'install')
 25 |  * and status reporting ($phase == 'runtime').
 26 |  *
 27 |  * Note that this hook, like all others dealing with installation and updates,
 28 |  * must reside in a module_name.install file, or it will not properly abort
 29 |  * the installation of the module if a critical requirement is missing.
 30 |  *
 31 |  * During the 'install' phase, modules can for example assert that
 32 |  * library or server versions are available or sufficient.
 33 |  * Note that the installation of a module can happen during installation of
 34 |  * Drupal itself (by install.php) with an installation profile or later by hand.
 35 |  * As a consequence, install-time requirements must be checked without access
 36 |  * to the full Drupal API, because it is not available during install.php.
 37 |  * For localisation you should for example use $t = get_t() to
 38 |  * retrieve the appropriate localisation function name (t() or st()).
 39 |  * If a requirement has a severity of REQUIREMENT_ERROR, install.php will abort
 40 |  * or at least the module will not install.
 41 |  * Other severity levels have no effect on the installation.
 42 |  * Module dependencies do not belong to these installation requirements,
 43 |  * but should be defined in the module's .info file.
 44 |  *
 45 |  * The 'runtime' phase is not limited to pure installation requirements
 46 |  * but can also be used for more general status information like maintenance
 47 |  * tasks and security issues.
 48 |  * The returned 'requirements' will be listed on the status report in the
 49 |  * administration section, with indication of the severity level.
 50 |  * Moreover, any requirement with a severity of REQUIREMENT_ERROR severity will
 51 |  * result in a notice on the the administration overview page.
 52 |  *
 53 |  * @param $phase
 54 |  *   The phase in which hook_requirements is run:
 55 |  *   - 'install': the module is being installed.
 56 |  *   - 'runtime': the runtime requirements are being checked and shown on the
 57 |  *              status report page.
 58 |  *
 59 |  * @return
 60 |  *   A keyed array of requirements. Each requirement is itself an array with
 61 |  *   the following items:
 62 |  *     - 'title': the name of the requirement.
 63 |  *     - 'value': the current value (e.g. version, time, level, ...). During
 64 |  *       install phase, this should only be used for version numbers, do not set
 65 |  *       it if not applicable.
 66 |  *     - 'description': description of the requirement/status.
 67 |  *     - 'severity': the requirement's result/severity level, one of:
 68 |  *         - REQUIREMENT_INFO:    For info only.
 69 |  *         - REQUIREMENT_OK:      The requirement is satisfied.
 70 |  *         - REQUIREMENT_WARNING: The requirement failed with a warning.
 71 |  *         - REQUIREMENT_ERROR:   The requirement failed with an error.
 72 |  */
 73 | function hook_requirements($phase) {
 74 |   $requirements = array();
 75 |   // Ensure translations don't break at install time
 76 |   $t = get_t();
 77 | 
 78 |   // Report Drupal version
 79 |   if ($phase == 'runtime') {
 80 |     $requirements['drupal'] = array(
 81 |       'title' => $t('Drupal'),
 82 |       'value' => VERSION,
 83 |       'severity' => REQUIREMENT_INFO
 84 |     );
 85 |   }
 86 | 
 87 |   // Test PHP version
 88 |   $requirements['php'] = array(
 89 |     'title' => $t('PHP'),
 90 |     'value' => ($phase == 'runtime') ? l(phpversion(), 'admin/logs/status/php') : phpversion(),
 91 |   );
 92 |   if (version_compare(phpversion(), DRUPAL_MINIMUM_PHP) < 0) {
 93 |     $requirements['php']['description'] = $t('Your PHP installation is too old. Drupal requires at least PHP %version.', array('%version' => DRUPAL_MINIMUM_PHP));
 94 |     $requirements['php']['severity'] = REQUIREMENT_ERROR;
 95 |   }
 96 | 
 97 |   // Report cron status
 98 |   if ($phase == 'runtime') {
 99 |     $cron_last = variable_get('cron_last', NULL);
100 | 
101 |     if (is_numeric($cron_last)) {
102 |       $requirements['cron']['value'] = $t('Last run !time ago', array('!time' => format_interval(time() - $cron_last)));
103 |     }
104 |     else {
105 |       $requirements['cron'] = array(
106 |         'description' => $t('Cron has not run. It appears cron jobs have not been setup on your system. Please check the help pages for <a href="@url">configuring cron jobs</a>.', array('@url' => 'http://drupal.org/cron')),
107 |         'severity' => REQUIREMENT_ERROR,
108 |         'value' => $t('Never run'),
109 |       );
110 |     }
111 | 
112 |     $requirements['cron']['description'] .= ' '. t('You can <a href="@cron">run cron manually</a>.', array('@cron' => url('admin/logs/status/run-cron')));
113 | 
114 |     $requirements['cron']['title'] = $t('Cron maintenance tasks');
115 |   }
116 | 
117 |   return $requirements;
118 | }
119 | 
120 | /**
121 |  * Define the current version of the database schema.
122 |  *
123 |  * A Drupal schema definition is an array structure representing one or
124 |  * more tables and their related keys and indexes. A schema is defined by
125 |  * hook_schema() which must live in your module's .install file.
126 |  *
127 |  * By implementing hook_schema() and specifying the tables your module
128 |  * declares, you can easily create and drop these tables on all
129 |  * supported database engines. You don't have to deal with the
130 |  * different SQL dialects for table creation and alteration of the
131 |  * supported database engines.
132 |  *
133 |  * See the Schema API Handbook at http://drupal.org/node/146843 for
134 |  * details on schema definition structures.
135 |  *
136 |  * @return
137 |  * A schema definition structure array.  For each element of the
138 |  * array, the key is a table name and the value is a table structure
139 |  * definition.
140 |  */
141 | function hook_schema() {
142 |   $schema['node'] = array(
143 |     // example (partial) specification for table "node"
144 |     'description' => 'The base table for nodes.',
145 |     'fields' => array(
146 |       'nid' => array(
147 |         'description' => 'The primary identifier for a node.',
148 |         'type' => 'serial',
149 |         'unsigned' => TRUE,
150 |         'not null' => TRUE),
151 |       'vid' => array(
152 |         'description' => 'The current {node_revisions}.vid version identifier.',
153 |         'type' => 'int',
154 |         'unsigned' => TRUE,
155 |         'not null' => TRUE,
156 |         'default' => 0),
157 |       'type' => array(
158 |         'description' => 'The {node_type} of this node.',
159 |         'type' => 'varchar',
160 |         'length' => 32,
161 |         'not null' => TRUE,
162 |         'default' => ''),
163 |       'title' => array(
164 |         'description' => 'The title of this node, always treated as non-markup plain text.',
165 |         'type' => 'varchar',
166 |         'length' => 255,
167 |         'not null' => TRUE,
168 |         'default' => ''),
169 |       ),
170 |     'indexes' => array(
171 |       'node_changed'        => array('changed'),
172 |       'node_created'        => array('created'),
173 |       ),
174 |     'unique keys' => array(
175 |       'nid_vid' => array('nid', 'vid'),
176 |       'vid'     => array('vid')
177 |       ),
178 |     'primary key' => array('nid'),
179 |   );
180 |   return $schema;
181 | }
182 | 
183 | /**
184 |  * Install the current version of the database schema, and any other setup tasks.
185 |  *
186 |  * The hook will be called the first time a module is installed, and the
187 |  * module's schema version will be set to the module's greatest numbered update
188 |  * hook. Because of this, anytime a hook_update_N() is added to the module, this
189 |  * function needs to be updated to reflect the current version of the database
190 |  * schema.
191 |  *
192 |  * See the Schema API documentation at http://drupal.org/node/146843 for
193 |  * details on hook_schema, where a database tables are defined.
194 |  *
195 |  * Note that functions declared in the module being installed are not yet
196 |  * available. The implementation of hook_install() will need to explicitly load
197 |  * the module before any declared functions may be invoked.
198 |  *
199 |  * Anything added or modified in this function that can be removed during
200 |  * uninstall should be removed with hook_uninstall().
201 |  */
202 | function hook_install() {
203 |   drupal_install_schema('upload');
204 | }
205 | 
206 | /**
207 |  * Perform a single update.
208 |  *
209 |  * For each patch which requires a database change add a new hook_update_N()
210 |  * which will be called by update.php. The database updates are numbered
211 |  * sequentially according to the version of Drupal you are compatible with.
212 |  *
213 |  * Schema updates should adhere to the Schema API: http://drupal.org/node/150215
214 |  *
215 |  * Database updates consist of 3 parts:
216 |  * - 1 digit for Drupal core compatibility
217 |  * - 1 digit for your module's major release version (e.g. is this the 5.x-1.* (1) or 5.x-2.* (2) series of your module?)
218 |  * - 2 digits for sequential counting starting with 00
219 |  *
220 |  * The 2nd digit should be 0 for initial porting of your module to a new Drupal
221 |  * core API.
222 |  *
223 |  * Examples:
224 |  * - mymodule_update_5200()
225 |  *   - This is the first update to get the database ready to run mymodule 5.x-2.*.
226 |  * - mymodule_update_6000()
227 |  *   - This is the required update for mymodule to run with Drupal core API 6.x.
228 |  * - mymodule_update_6100()
229 |  *   - This is the first update to get the database ready to run mymodule 6.x-1.*.
230 |  * - mymodule_update_6200()
231 |  *   - This is the first update to get the database ready to run mymodule 6.x-2.*.
232 |  *     Users can directly update from 5.x-2.* to 6.x-2.* and they get all 60XX
233 |  *     and 62XX updates, but not 61XX updates, because those reside in the
234 |  *     6.x-1.x branch only.
235 |  *
236 |  * A good rule of thumb is to remove updates older than two major releases of
237 |  * Drupal. See hook_update_last_removed() to notify Drupal about the removals.
238 |  *
239 |  * Never renumber update functions.
240 |  *
241 |  * Further information about releases and release numbers:
242 |  * - http://drupal.org/handbook/version-info
243 |  * - http://drupal.org/node/93999 (Overview of contributions branches and tags)
244 |  * - http://drupal.org/handbook/cvs/releases
245 |  *
246 |  * Implementations of this hook should be placed in a mymodule.install file in
247 |  * the same directory as mymodule.module. Drupal core's updates are implemented
248 |  * using the system module as a name and stored in database/updates.inc.
249 |  *
250 |  * @return An array with the results of the calls to update_sql(). An update
251 |  *   function can force the current and all later updates for this
252 |  *   module to abort by returning a $ret array with an element like:
253 |  *   $ret['#abort'] = array('success' => FALSE, 'query' => 'What went wrong');
254 |  *   The schema version will not be updated in this case, and all the
255 |  *   aborted updates will continue to appear on update.php as updates that
256 |  *   have not yet been run. Multipass update functions will also want to pass
257 |  *   back the $ret['#finished'] variable to inform the batch API of progress.
258 |  */
259 | function hook_update_N(&$sandbox) {
260 |   // For non-multipass updates, the signature can simply be;
261 |   // function hook_update_N() {
262 | 
263 |   // For most updates, the following is sufficient.
264 |   $ret = array();
265 |   db_add_field($ret, 'mytable1', 'newcol', array('type' => 'int', 'not null' => TRUE));
266 |   return $ret;
267 | 
268 |   // However, for more complex operations that may take a long time,
269 |   // you may hook into Batch API as in the following example.
270 |   $ret = array();
271 | 
272 |   // Update 3 users at a time to have an exclamation point after their names.
273 |   // (They're really happy that we can do batch API in this hook!)
274 |   if (!isset($sandbox['progress'])) {
275 |     $sandbox['progress'] = 0;
276 |     $sandbox['current_uid'] = 0;
277 |     // We'll -1 to disregard the uid 0...
278 |     $sandbox['max'] = db_result(db_query('SELECT COUNT(DISTINCT uid) FROM {users}')) - 1;
279 |   }
280 | 
281 |   $users = db_query_range("SELECT uid, name FROM {users} WHERE uid > %d ORDER BY uid ASC", $sandbox['current_uid'], 0, 3);
282 |   while ($user = db_fetch_object($users)) {
283 |     $user->name .= '!';
284 |     $ret[] = update_sql("UPDATE {users} SET name = '$user->name' WHERE uid = $user->uid");
285 | 
286 |     $sandbox['progress']++;
287 |     $sandbox['current_uid'] = $user->uid;
288 |   }
289 | 
290 |   $ret['#finished'] = empty($sandbox['max']) ? 1 : ($sandbox['progress'] / $sandbox['max']);
291 | 
292 |   return $ret;
293 | }
294 | 
295 | /**
296 |  * Remove any tables or variables that the module sets.
297 |  *
298 |  * The uninstall hook will fire when the module gets uninstalled.
299 |  */
300 | function hook_uninstall() {
301 |   drupal_uninstall_schema('upload');
302 |   variable_del('upload_file_types');
303 | }
304 | 
305 | /**
306 |  * Return a number which is no longer available as hook_update_N().
307 |  *
308 |  * If you remove some update functions from your mymodule.install file, you
309 |  * should notify Drupal of those missing functions. This way, Drupal can
310 |  * ensure that no update is accidentally skipped.
311 |  *
312 |  * Implementations of this hook should be placed in a mymodule.install file in
313 |  * the same directory as mymodule.module.
314 |  *
315 |  * @return
316 |  *   An integer, corresponding to hook_update_N() which has been removed from
317 |  *   mymodule.install.
318 |  *
319 |  * @see hook_update_N()
320 |  */
321 | function hook_update_last_removed() {
322 |   // We've removed the 5.x-1.x version of mymodule, including database updates.
323 |   // The next update function is mymodule_update_5200().
324 |   return 5103;
325 | }
326 | 
327 | 
328 | /**
329 |  * Perform necessary actions after module is enabled.
330 |  *
331 |  * The hook is called everytime module is enabled.
332 |  */
333 | function hook_enable() {
334 |   mymodule_cache_rebuild();
335 | }
336 | 
337 | /**
338 |  * Perform necessary actions before module is disabled.
339 |  *
340 |  * The hook is called everytime module is disabled.
341 |  */
342 | function hook_disable() {
343 |   mymodule_cache_rebuild();
344 | }
345 | 
346 | /**
347 |  * @} End of "addtogroup hooks".
348 |  */
349 | 


--------------------------------------------------------------------------------
/developer/hooks/node.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | // $Id: node.php,v 1.41.2.7 2010/05/18 16:12:29 jhodgdon Exp $
  3 | 
  4 | /**
  5 |  * @file
  6 |  * These hooks are defined by node modules, modules that define a new kind
  7 |  * of node.
  8 |  *
  9 |  * If you don't need to make a new node type but rather extend the existing
 10 |  * ones, you should instead investigate using hook_nodeapi().
 11 |  *
 12 |  * Node hooks are typically called by node.module using node_invoke().
 13 |  */
 14 | 
 15 | /**
 16 |  * @addtogroup hooks
 17 |  * @{
 18 |  */
 19 | 
 20 | 
 21 | /**
 22 |  * Define module-provided node types.
 23 |  *
 24 |  * This is a hook used by node modules. This hook is required for modules to
 25 |  * define one or more node types. It is called to determine the names and the
 26 |  * attributes of a module's node types.
 27 |  *
 28 |  * Only module-provided node types should be defined through this hook. User-
 29 |  * provided (or 'custom') node types should be defined only in the 'node_type'
 30 |  * database table, and should be maintained by using the node_type_save() and
 31 |  * node_type_delete() functions.
 32 |  *
 33 |  * @return
 34 |  *   An array of information on the module's node types. The array contains a
 35 |  *   sub-array for each node type, with the machine-readable type name as the
 36 |  *   key. Each sub-array has up to 10 attributes. Possible attributes:
 37 |  *   - "name": the human-readable name of the node type. Required.
 38 |  *   - "module": a string telling Drupal how a module's functions map to hooks
 39 |  *      (i.e. if module is defined as example_foo, then example_foo_insert will
 40 |  *      be called when inserting a node of that type). This string is usually
 41 |  *      the name of the module in question, but not always. Required.
 42 |  *   - "description": a brief description of the node type. Required.
 43 |  *   - "help": text that will be displayed at the top of the submission form for
 44 |  *      this content type. Optional (defaults to '').
 45 |  *   - "has_title": boolean indicating whether or not this node type has a title
 46 |  *      field. Optional (defaults to TRUE).
 47 |  *   - "title_label": the label for the title field of this content type.
 48 |  *      Optional (defaults to 'Title').
 49 |  *   - "has_body": boolean indicating whether or not this node type has a  body
 50 |  *      field. Optional (defaults to TRUE).
 51 |  *   - "body_label": the label for the body field of this content type. Optional
 52 |  *      (defaults to 'Body').
 53 |  *   - "min_word_count": the minimum number of words for the body field to be
 54 |  *      considered valid for this content type. Optional (defaults to 0).
 55 |  *   - "locked": boolean indicating whether the machine-readable name of this
 56 |  *      content type can (FALSE) or cannot (TRUE) be edited by a site
 57 |  *      administrator. Optional (defaults to TRUE).
 58 |  *
 59 |  * The machine-readable name of a node type should contain only letters,
 60 |  * numbers, and underscores. Underscores will be converted into hyphens for the
 61 |  * purpose of constructing URLs.
 62 |  *
 63 |  * All attributes of a node type that are defined through this hook (except for
 64 |  * 'locked') can be edited by a site administrator. This includes the
 65 |  * machine-readable name of a node type, if 'locked' is set to FALSE.
 66 |  *
 67 |  * For a detailed usage example, see node_example.module.
 68 |  */
 69 | function hook_node_info() {
 70 |   return array(
 71 |     'book' => array(
 72 |       'name' => t('book page'),
 73 |       'module' => 'book',
 74 |       'description' => t("A book is a collaborative writing effort: users can collaborate writing the pages of the book, positioning the pages in the right order, and reviewing or modifying pages previously written. So when you have some information to share or when you read a page of the book and you didn't like it, or if you think a certain page could have been written better, you can do something about it."),
 75 |     )
 76 |   );
 77 | }
 78 | 
 79 | /**
 80 |  * Act on node type changes.
 81 |  *
 82 |  * This hook allows modules to take action when a node type is modified.
 83 |  *
 84 |  * @param $op
 85 |  *   What is being done to $info. Possible values:
 86 |  *   - "delete"
 87 |  *   - "insert"
 88 |  *   - "update"
 89 |  * @param $info
 90 |  *   The node type object on which $op is being performed.
 91 |  * @return
 92 |  *   None.
 93 |  */
 94 | function hook_node_type($op, $info) {
 95 | 
 96 |   switch ($op){
 97 |     case 'delete':
 98 |       variable_del('comment_'. $info->type);
 99 |       break;
100 |     case 'update':
101 |       if (!empty($info->old_type) && $info->old_type != $info->type) {
102 |         $setting = variable_get('comment_'. $info->old_type, COMMENT_NODE_READ_WRITE);
103 |         variable_del('comment_'. $info->old_type);
104 |         variable_set('comment_'. $info->type, $setting);
105 |       }
106 |       break;
107 |   }
108 | }
109 | 
110 | /**
111 |  * Define access restrictions.
112 |  *
113 |  * This hook allows node modules to limit access to the node types they
114 |  * define.
115 |  *
116 |  * @param $op
117 |  *   The operation to be performed. Possible values:
118 |  *   - "create"
119 |  *   - "delete"
120 |  *   - "update"
121 |  *   - "view"
122 |  * @param $node
123 |  *   The node on which the operation is to be performed, or, if it does
124 |  *   not yet exist, the type of node to be created.
125 |  * @param $account
126 |  *   A user object representing the user for whom the operation is to be
127 |  *   performed.
128 |  * @return
129 |  *   TRUE if the operation is  to be allowed;
130 |  *   FALSE if the operation is to be denied;
131 |  *   NULL to not override the settings in the node_access table, or access
132 |  *     control modules.
133 |  *
134 |  * The administrative account (user ID #1) always passes any access check,
135 |  * so this hook is not called in that case. If this hook is not defined for
136 |  * a node type, all access checks will fail, so only the administrator will
137 |  * be able to see content of that type. However, users with the "administer
138 |  * nodes" permission may always view and edit content through the
139 |  * administrative interface.
140 |  * @see http://api.drupal.org/api/group/node_access/6
141 |  *
142 |  * For a detailed usage example, see node_example.module.
143 |  *
144 |  * @ingroup node_access
145 |  */
146 | function hook_access($op, $node, $account) {
147 |   if ($op == 'create') {
148 |     return user_access('create stories', $account);
149 |   }
150 | 
151 |   if ($op == 'update' || $op == 'delete') {
152 |     if (user_access('edit own stories', $account) && ($account->uid == $node->uid)) {
153 |       return TRUE;
154 |     }
155 |   }
156 | }
157 | 
158 | /**
159 |  * Respond to node deletion.
160 |  *
161 |  * This is a hook used by node modules. It is called to allow the module
162 |  * to take action when a node is being deleted from the database by, for
163 |  * example, deleting information from related tables.
164 |  *
165 |  * @param &$node
166 |  *   The node being deleted.
167 |  * @return
168 |  *   None.
169 |  *
170 |  * To take action when nodes of any type are deleted (not just nodes of
171 |  * the type defined by this module), use hook_nodeapi() instead.
172 |  *
173 |  * For a detailed usage example, see node_example.module.
174 |  */
175 | function hook_delete(&$node) {
176 |   db_query('DELETE FROM {mytable} WHERE nid = %d', $node->nid);
177 | }
178 | 
179 | /**
180 |  * This is a hook used by node modules. It is called after load but before the
181 |  * node is shown on the add/edit form.
182 |  *
183 |  * @param &$node
184 |  *   The node being saved.
185 |  * @return
186 |  *   None.
187 |  *
188 |  * For a usage example, see image.module.
189 |  */
190 | function hook_prepare(&$node) {
191 |   if ($file = file_check_upload($field_name)) {
192 |     $file = file_save_upload($field_name, _image_filename($file->filename, NULL, TRUE));
193 |     if ($file) {
194 |       if (!image_get_info($file->filepath)) {
195 |         form_set_error($field_name, t('Uploaded file is not a valid image'));
196 |         return;
197 |       }
198 |     }
199 |     else {
200 |       return;
201 |     }
202 |     $node->images['_original'] = $file->filepath;
203 |     _image_build_derivatives($node, true);
204 |     $node->new_file = TRUE;
205 |   }
206 | }
207 | 
208 | 
209 | /**
210 |  * Display a node editing form.
211 |  *
212 |  * This hook, implemented by node modules, is called to retrieve the form
213 |  * that is displayed when one attempts to "create/edit" an item. This form is
214 |  * displayed at the URI http://www.example.com/?q=node/<add|edit>/nodetype.
215 |  *
216 |  * @param &$node
217 |  *   The node being added or edited.
218 |  * @param $form_state
219 |  *   The form state array. Changes made to this variable will have no effect.
220 |  * @return
221 |  *   An array containing the form elements to be displayed in the node
222 |  *   edit form.
223 |  *
224 |  * The submit and preview buttons, taxonomy controls, and administrative
225 |  * accoutrements are displayed automatically by node.module. This hook
226 |  * needs to return the node title, the body text area, and fields
227 |  * specific to the node type.
228 |  *
229 |  * For a detailed usage example, see node_example.module.
230 |  */
231 | function hook_form(&$node, $form_state) {
232 |   $type = node_get_types('type', $node);
233 | 
234 |   $form['title'] = array(
235 |     '#type'=> 'textfield',
236 |     '#title' => check_plain($type->title_label),
237 |     '#required' => TRUE,
238 |   );
239 |   $form['body'] = array(
240 |     '#type' => 'textarea',
241 |     '#title' => check_plain($type->body_label),
242 |     '#rows' => 20,
243 |     '#required' => TRUE,
244 |   );
245 |   $form['field1'] = array(
246 |     '#type' => 'textfield',
247 |     '#title' => t('Custom field'),
248 |     '#default_value' => $node->field1,
249 |     '#maxlength' => 127,
250 |   );
251 |   $form['selectbox'] = array(
252 |     '#type' => 'select',
253 |     '#title' => t('Select box'),
254 |     '#default_value' => $node->selectbox,
255 |     '#options' => array(
256 |       1 => 'Option A',
257 |       2 => 'Option B',
258 |       3 => 'Option C',
259 |     ),
260 |     '#description' => t('Please choose an option.'),
261 |   );
262 | 
263 |   return $form;
264 | }
265 | 
266 | /**
267 |  * Respond to node insertion.
268 |  *
269 |  * This is a hook used by node modules. It is called to allow the module
270 |  * to take action when a new node is being inserted in the database by,
271 |  * for example, inserting information into related tables.
272 |  *
273 |  * @param $node
274 |  *   The node being inserted.
275 |  * @return
276 |  *   None.
277 |  *
278 |  * To take action when nodes of any type are inserted (not just nodes of
279 |  * the type(s) defined by this module), use hook_nodeapi() instead.
280 |  *
281 |  * For a detailed usage example, see node_example.module.
282 |  */
283 | function hook_insert($node) {
284 |   db_query("INSERT INTO {mytable} (nid, extra)
285 |     VALUES (%d, '%s')", $node->nid, $node->extra);
286 | }
287 | 
288 | /**
289 |  * Load node-type-specific information.
290 |  *
291 |  * This is a hook used by node modules. It is called to allow the module
292 |  * a chance to load extra information that it stores about a node, or
293 |  * possibly replace already loaded information - which can be dangerous.
294 |  *
295 |  * @param $node
296 |  *   The node being loaded. At call time, node.module has already loaded
297 |  *   the basic information about the node, such as its node ID (nid),
298 |  *   title, and body.
299 |  * @return
300 |  *   An object containing properties of the node being loaded. This will
301 |  *   be merged with the passed-in $node to result in an object containing
302 |  *   a set of properties resulting from adding the extra properties to
303 |  *   the passed-in ones, and overwriting the passed-in ones with the
304 |  *   extra properties if they have the same name as passed-in properties.
305 |  *
306 |  * For a detailed usage example, see node_example.module.
307 |  */
308 | function hook_load($node) {
309 |   $additions = db_fetch_object(db_query('SELECT * FROM {mytable} WHERE vid = %d', $node->vid));
310 |   return $additions;
311 | }
312 | 
313 | /**
314 |  * Respond to node updating.
315 |  *
316 |  * This is a hook used by node modules. It is called to allow the module
317 |  * to take action when an edited node is being updated in the database by,
318 |  * for example, updating information in related tables.
319 |  *
320 |  * @param $node
321 |  *   The node being updated.
322 |  * @return
323 |  *   None.
324 |  *
325 |  * To take action when nodes of any type are updated (not just nodes of
326 |  * the type(s) defined by this module), use hook_nodeapi() instead.
327 |  *
328 |  * For a detailed usage example, see node_example.module.
329 |  */
330 | function hook_update($node) {
331 |   db_query("UPDATE {mytable} SET extra = '%s' WHERE nid = %d",
332 |     $node->extra, $node->nid);
333 | }
334 | 
335 | /**
336 |  * Verify a node editing form.
337 |  *
338 |  * This is a hook used by node modules. It is called to allow the module
339 |  * to verify that the node is in a format valid to post to the site.
340 |  * Errors should be set with form_set_error().
341 |  *
342 |  * @param $node
343 |  *   The node to be validated.
344 |  * @param $form
345 |  *   The node edit form array.
346 |  * @return
347 |  *   None.
348 |  *
349 |  * To validate nodes of all types (not just nodes of the type(s) defined by
350 |  * this module), use hook_nodeapi() instead.
351 |  *
352 |  * Changes made to the $node object within a hook_validate() function will
353 |  * have no effect.  The preferred method to change a node's content is to use
354 |  * hook_nodeapi($op='presave') instead. If it is really necessary to change
355 |  * the node at the validate stage, you can use function form_set_value().
356 |  *
357 |  * For a detailed usage example, see node_example.module.
358 |  */
359 | function hook_validate($node, &$form) {
360 |   if (isset($node->end) && isset($node->start)) {
361 |     if ($node->start > $node->end) {
362 |       form_set_error('time', t('An event may not end before it starts.'));
363 |     }
364 |   }
365 | }
366 | 
367 | /**
368 |  * Display a node.
369 |  *
370 |  * This is a hook used by node modules. It allows a module to define a
371 |  * custom method of displaying its nodes, usually by displaying extra
372 |  * information particular to that node type.
373 |  *
374 |  * @param $node
375 |  *   The node to be displayed.
376 |  * @param $teaser
377 |  *   Whether we are to generate a "teaser" or summary of the node, rather than
378 |  *   display the whole thing.
379 |  * @param $page
380 |  *   Whether the node is being displayed as a standalone page. If this is
381 |  *   TRUE, the node title should not be displayed, as it will be printed
382 |  *   automatically by the theme system. Also, the module may choose to alter
383 |  *   the default breadcrumb trail in this case.
384 |  * @return
385 |  *   $node. The passed $node parameter should be modified as necessary and
386 |  *   returned so it can be properly presented. Nodes are prepared for display
387 |  *   by assembling a structured array in $node->content, rather than directly
388 |  *   manipulating $node->body and $node->teaser. The format of this array is
389 |  *   the same used by the Forms API. As with FormAPI arrays, the #weight
390 |  *   property can be used to control the relative positions of added elements.
391 |  *   If for some reason you need to change the body or teaser returned by
392 |  *   node_prepare(), you can modify $node->content['body']['#value']. Note
393 |  *   that this will be the un-rendered content. To modify the rendered output,
394 |  *   see hook_nodeapi($op = 'alter').
395 |  *
396 |  * For a detailed usage example, see node_example.module.
397 |  */
398 | function hook_view($node, $teaser = FALSE, $page = FALSE) {
399 |   if ($page) {
400 |     $breadcrumb = array();
401 |     $breadcrumb[] = l(t('Home'), NULL);
402 |     $breadcrumb[] = l(t('Example'), 'example');
403 |     $breadcrumb[] = l($node->field1, 'example/' . $node->field1);
404 |     drupal_set_breadcrumb($breadcrumb);
405 |   }
406 | 
407 |   $node = node_prepare($node, $teaser);
408 |   $node->content['myfield'] = array(
409 |     '#value' => theme('mymodule_myfield', $node->myfield),
410 |     '#weight' => 1,
411 |   );
412 | 
413 |   return $node;
414 | }
415 | 
416 | /**
417 |  * @} End of "addtogroup hooks".
418 |  */
419 | 


--------------------------------------------------------------------------------
/config.doxy:
--------------------------------------------------------------------------------
   1 | # Doxyfile 1.7.1
   2 | 
   3 | # This file describes the settings to be used by the documentation system
   4 | # doxygen (www.doxygen.org) for a project
   5 | #
   6 | # All text after a hash (#) is considered a comment and will be ignored
   7 | # The format is:
   8 | #       TAG = value [value, ...]
   9 | # For lists items can also be appended using:
  10 | #       TAG += value [value, ...]
  11 | # Values that contain spaces should be placed between quotes (" ")
  12 | 
  13 | #---------------------------------------------------------------------------
  14 | # Project related configuration options
  15 | #---------------------------------------------------------------------------
  16 | 
  17 | # This tag specifies the encoding used for all characters in the config file 
  18 | # that follow. The default is UTF-8 which is also the encoding used for all 
  19 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 
  20 | # iconv built into libc) for the transcoding. See 
  21 | # http://www.gnu.org/software/libiconv for the list of possible encodings.
  22 | 
  23 | DOXYFILE_ENCODING      = UTF-8
  24 | 
  25 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded 
  26 | # by quotes) that should identify the project.
  27 | 
  28 | PROJECT_NAME           = CHANGE ME 
  29 | 
  30 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. 
  31 | # This could be handy for archiving the generated documentation or 
  32 | # if some version control system is used.
  33 | 
  34 | PROJECT_NUMBER         = 0 
  35 | 
  36 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) 
  37 | # base path where the generated documentation will be put. 
  38 | # If a relative path is entered, it will be relative to the location 
  39 | # where doxygen was started. If left blank the current directory will be used.
  40 | 
  41 | OUTPUT_DIRECTORY       = docs
  42 | 
  43 | # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
  44 | # 4096 sub-directories (in 2 levels) under the output directory of each output 
  45 | # format and will distribute the generated files over these directories. 
  46 | # Enabling this option can be useful when feeding doxygen a huge amount of 
  47 | # source files, where putting all generated files in the same directory would 
  48 | # otherwise cause performance problems for the file system.
  49 | 
  50 | CREATE_SUBDIRS         = NO
  51 | 
  52 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
  53 | # documentation generated by doxygen is written. Doxygen will use this 
  54 | # information to generate all constant output in the proper language. 
  55 | # The default language is English, other supported languages are: 
  56 | # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, 
  57 | # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, 
  58 | # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English 
  59 | # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, 
  60 | # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, 
  61 | # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
  62 | 
  63 | OUTPUT_LANGUAGE        = English
  64 | 
  65 | # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will 
  66 | # include brief member descriptions after the members that are listed in 
  67 | # the file and class documentation (similar to JavaDoc). 
  68 | # Set to NO to disable this.
  69 | 
  70 | BRIEF_MEMBER_DESC      = YES
  71 | 
  72 | # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend 
  73 | # the brief description of a member or function before the detailed description. 
  74 | # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 
  75 | # brief descriptions will be completely suppressed.
  76 | 
  77 | REPEAT_BRIEF           = YES
  78 | 
  79 | # This tag implements a quasi-intelligent brief description abbreviator 
  80 | # that is used to form the text in various listings. Each string 
  81 | # in this list, if found as the leading text of the brief description, will be 
  82 | # stripped from the text and the result after processing the whole list, is 
  83 | # used as the annotated text. Otherwise, the brief description is used as-is. 
  84 | # If left blank, the following values are used ("$name" is automatically 
  85 | # replaced with the name of the entity): "The $name class" "The $name widget" 
  86 | # "The $name file" "is" "provides" "specifies" "contains" 
  87 | # "represents" "a" "an" "the"
  88 | 
  89 | ABBREVIATE_BRIEF       = "The $name class" \
  90 |                          "The $name widget" \
  91 |                          "The $name file" \
  92 |                          is \
  93 |                          provides \
  94 |                          specifies \
  95 |                          contains \
  96 |                          represents \
  97 |                          a \
  98 |                          an \
  99 |                          the
 100 | 
 101 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 
 102 | # Doxygen will generate a detailed section even if there is only a brief 
 103 | # description.
 104 | 
 105 | ALWAYS_DETAILED_SEC    = NO
 106 | 
 107 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 
 108 | # inherited members of a class in the documentation of that class as if those 
 109 | # members were ordinary class members. Constructors, destructors and assignment 
 110 | # operators of the base classes will not be shown.
 111 | 
 112 | INLINE_INHERITED_MEMB  = NO
 113 | 
 114 | # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full 
 115 | # path before files name in the file list and in the header files. If set 
 116 | # to NO the shortest path that makes the file name unique will be used.
 117 | 
 118 | FULL_PATH_NAMES        = YES
 119 | 
 120 | # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag 
 121 | # can be used to strip a user-defined part of the path. Stripping is 
 122 | # only done if one of the specified strings matches the left-hand part of 
 123 | # the path. The tag can be used to show relative paths in the file list. 
 124 | # If left blank the directory from which doxygen is run is used as the 
 125 | # path to strip.
 126 | 
 127 | STRIP_FROM_PATH        = 
 128 | 
 129 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of 
 130 | # the path mentioned in the documentation of a class, which tells 
 131 | # the reader which header file to include in order to use a class. 
 132 | # If left blank only the name of the header file containing the class 
 133 | # definition is used. Otherwise one should specify the include paths that 
 134 | # are normally passed to the compiler using the -I flag.
 135 | 
 136 | STRIP_FROM_INC_PATH    = 
 137 | 
 138 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter 
 139 | # (but less readable) file names. This can be useful is your file systems 
 140 | # doesn't support long names like on DOS, Mac, or CD-ROM.
 141 | 
 142 | SHORT_NAMES            = NO
 143 | 
 144 | # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen 
 145 | # will interpret the first line (until the first dot) of a JavaDoc-style 
 146 | # comment as the brief description. If set to NO, the JavaDoc 
 147 | # comments will behave just like regular Qt-style comments 
 148 | # (thus requiring an explicit @brief command for a brief description.)
 149 | 
 150 | JAVADOC_AUTOBRIEF      = NO
 151 | 
 152 | # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
 153 | # interpret the first line (until the first dot) of a Qt-style 
 154 | # comment as the brief description. If set to NO, the comments 
 155 | # will behave just like regular Qt-style comments (thus requiring 
 156 | # an explicit \brief command for a brief description.)
 157 | 
 158 | QT_AUTOBRIEF           = NO
 159 | 
 160 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen 
 161 | # treat a multi-line C++ special comment block (i.e. a block of //! or /// 
 162 | # comments) as a brief description. This used to be the default behaviour. 
 163 | # The new default is to treat a multi-line C++ comment block as a detailed 
 164 | # description. Set this tag to YES if you prefer the old behaviour instead.
 165 | 
 166 | MULTILINE_CPP_IS_BRIEF = NO
 167 | 
 168 | # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented 
 169 | # member inherits the documentation from any documented member that it 
 170 | # re-implements.
 171 | 
 172 | INHERIT_DOCS           = YES
 173 | 
 174 | # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce 
 175 | # a new page for each member. If set to NO, the documentation of a member will 
 176 | # be part of the file/class/namespace that contains it.
 177 | 
 178 | SEPARATE_MEMBER_PAGES  = NO
 179 | 
 180 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
 181 | # Doxygen uses this value to replace tabs by spaces in code fragments.
 182 | 
 183 | TAB_SIZE               = 2
 184 | 
 185 | # This tag can be used to specify a number of aliases that acts 
 186 | # as commands in the documentation. An alias has the form "name=value". 
 187 | # For example adding "sideeffect=\par Side Effects:\n" will allow you to 
 188 | # put the command \sideeffect (or @sideeffect) in the documentation, which 
 189 | # will result in a user-defined paragraph with heading "Side Effects:". 
 190 | # You can put \n's in the value part of an alias to insert newlines.
 191 | 
 192 | ALIASES                = 
 193 | 
 194 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
 195 | # sources only. Doxygen will then generate output that is more tailored for C. 
 196 | # For instance, some of the names that are used will be different. The list 
 197 | # of all members will be omitted, etc.
 198 | 
 199 | OPTIMIZE_OUTPUT_FOR_C  = NO
 200 | 
 201 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java 
 202 | # sources only. Doxygen will then generate output that is more tailored for 
 203 | # Java. For instance, namespaces will be presented as packages, qualified 
 204 | # scopes will look different, etc.
 205 | 
 206 | OPTIMIZE_OUTPUT_JAVA   = NO
 207 | 
 208 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 
 209 | # sources only. Doxygen will then generate output that is more tailored for 
 210 | # Fortran.
 211 | 
 212 | OPTIMIZE_FOR_FORTRAN   = NO
 213 | 
 214 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 
 215 | # sources. Doxygen will then generate output that is tailored for 
 216 | # VHDL.
 217 | 
 218 | OPTIMIZE_OUTPUT_VHDL   = NO
 219 | 
 220 | # Doxygen selects the parser to use depending on the extension of the files it 
 221 | # parses. With this tag you can assign which parser to use for a given extension. 
 222 | # Doxygen has a built-in mapping, but you can override or extend it using this 
 223 | # tag. The format is ext=language, where ext is a file extension, and language 
 224 | # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, 
 225 | # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make 
 226 | # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C 
 227 | # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions 
 228 | # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
 229 | 
 230 | EXTENSION_MAPPING      = 
 231 | 
 232 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
 233 | # to include (a tag file for) the STL sources as input, then you should 
 234 | # set this tag to YES in order to let doxygen match functions declarations and 
 235 | # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. 
 236 | # func(std::string) {}). This also make the inheritance and collaboration 
 237 | # diagrams that involve STL classes more complete and accurate.
 238 | 
 239 | BUILTIN_STL_SUPPORT    = NO
 240 | 
 241 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 
 242 | # enable parsing support.
 243 | 
 244 | CPP_CLI_SUPPORT        = NO
 245 | 
 246 | # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. 
 247 | # Doxygen will parse them like normal C++ but will assume all classes use public 
 248 | # instead of private inheritance when no explicit protection keyword is present.
 249 | 
 250 | SIP_SUPPORT            = NO
 251 | 
 252 | # For Microsoft's IDL there are propget and propput attributes to indicate getter 
 253 | # and setter methods for a property. Setting this option to YES (the default) 
 254 | # will make doxygen to replace the get and set methods by a property in the 
 255 | # documentation. This will only work if the methods are indeed getting or 
 256 | # setting a simple type. If this is not the case, or you want to show the 
 257 | # methods anyway, you should set this option to NO.
 258 | 
 259 | IDL_PROPERTY_SUPPORT   = YES
 260 | 
 261 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 
 262 | # tag is set to YES, then doxygen will reuse the documentation of the first 
 263 | # member in the group (if any) for the other members of the group. By default 
 264 | # all members of a group must be documented explicitly.
 265 | 
 266 | DISTRIBUTE_GROUP_DOC   = NO
 267 | 
 268 | # Set the SUBGROUPING tag to YES (the default) to allow class member groups of 
 269 | # the same type (for instance a group of public functions) to be put as a 
 270 | # subgroup of that type (e.g. under the Public Functions section). Set it to 
 271 | # NO to prevent subgrouping. Alternatively, this can be done per class using 
 272 | # the \nosubgrouping command.
 273 | 
 274 | SUBGROUPING            = YES
 275 | 
 276 | # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum 
 277 | # is documented as struct, union, or enum with the name of the typedef. So 
 278 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 
 279 | # with name TypeT. When disabled the typedef will appear as a member of a file, 
 280 | # namespace, or class. And the struct will be named TypeS. This can typically 
 281 | # be useful for C code in case the coding convention dictates that all compound 
 282 | # types are typedef'ed and only the typedef is referenced, never the tag name.
 283 | 
 284 | TYPEDEF_HIDES_STRUCT   = NO
 285 | 
 286 | # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to 
 287 | # determine which symbols to keep in memory and which to flush to disk. 
 288 | # When the cache is full, less often used symbols will be written to disk. 
 289 | # For small to medium size projects (<1000 input files) the default value is 
 290 | # probably good enough. For larger projects a too small cache size can cause 
 291 | # doxygen to be busy swapping symbols to and from disk most of the time 
 292 | # causing a significant performance penality. 
 293 | # If the system has enough physical memory increasing the cache will improve the 
 294 | # performance by keeping more symbols in memory. Note that the value works on 
 295 | # a logarithmic scale so increasing the size by one will rougly double the 
 296 | # memory usage. The cache size is given by this formula: 
 297 | # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, 
 298 | # corresponding to a cache size of 2^16 = 65536 symbols
 299 | 
 300 | SYMBOL_CACHE_SIZE      = 0
 301 | 
 302 | #---------------------------------------------------------------------------
 303 | # Build related configuration options
 304 | #---------------------------------------------------------------------------
 305 | 
 306 | # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in 
 307 | # documentation are documented, even if no documentation was available. 
 308 | # Private class members and static file members will be hidden unless 
 309 | # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
 310 | 
 311 | EXTRACT_ALL            = YES
 312 | 
 313 | # If the EXTRACT_PRIVATE tag is set to YES all private members of a class 
 314 | # will be included in the documentation.
 315 | 
 316 | EXTRACT_PRIVATE        = NO
 317 | 
 318 | # If the EXTRACT_STATIC tag is set to YES all static members of a file 
 319 | # will be included in the documentation.
 320 | 
 321 | EXTRACT_STATIC         = NO
 322 | 
 323 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) 
 324 | # defined locally in source files will be included in the documentation. 
 325 | # If set to NO only classes defined in header files are included.
 326 | 
 327 | EXTRACT_LOCAL_CLASSES  = YES
 328 | 
 329 | # This flag is only useful for Objective-C code. When set to YES local 
 330 | # methods, which are defined in the implementation section but not in 
 331 | # the interface are included in the documentation. 
 332 | # If set to NO (the default) only methods in the interface are included.
 333 | 
 334 | EXTRACT_LOCAL_METHODS  = NO
 335 | 
 336 | # If this flag is set to YES, the members of anonymous namespaces will be 
 337 | # extracted and appear in the documentation as a namespace called 
 338 | # 'anonymous_namespace{file}', where file will be replaced with the base 
 339 | # name of the file that contains the anonymous namespace. By default 
 340 | # anonymous namespace are hidden.
 341 | 
 342 | EXTRACT_ANON_NSPACES   = NO
 343 | 
 344 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all 
 345 | # undocumented members of documented classes, files or namespaces. 
 346 | # If set to NO (the default) these members will be included in the 
 347 | # various overviews, but no documentation section is generated. 
 348 | # This option has no effect if EXTRACT_ALL is enabled.
 349 | 
 350 | HIDE_UNDOC_MEMBERS     = NO
 351 | 
 352 | # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all 
 353 | # undocumented classes that are normally visible in the class hierarchy. 
 354 | # If set to NO (the default) these classes will be included in the various 
 355 | # overviews. This option has no effect if EXTRACT_ALL is enabled.
 356 | 
 357 | HIDE_UNDOC_CLASSES     = NO
 358 | 
 359 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all 
 360 | # friend (class|struct|union) declarations. 
 361 | # If set to NO (the default) these declarations will be included in the 
 362 | # documentation.
 363 | 
 364 | HIDE_FRIEND_COMPOUNDS  = NO
 365 | 
 366 | # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any 
 367 | # documentation blocks found inside the body of a function. 
 368 | # If set to NO (the default) these blocks will be appended to the 
 369 | # function's detailed documentation block.
 370 | 
 371 | HIDE_IN_BODY_DOCS      = NO
 372 | 
 373 | # The INTERNAL_DOCS tag determines if documentation 
 374 | # that is typed after a \internal command is included. If the tag is set 
 375 | # to NO (the default) then the documentation will be excluded. 
 376 | # Set it to YES to include the internal documentation.
 377 | 
 378 | INTERNAL_DOCS          = NO
 379 | 
 380 | # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate 
 381 | # file names in lower-case letters. If set to YES upper-case letters are also 
 382 | # allowed. This is useful if you have classes or files whose names only differ 
 383 | # in case and if your file system supports case sensitive file names. Windows 
 384 | # and Mac users are advised to set this option to NO.
 385 | 
 386 | CASE_SENSE_NAMES       = NO
 387 | 
 388 | # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen 
 389 | # will show members with their full class and namespace scopes in the 
 390 | # documentation. If set to YES the scope will be hidden.
 391 | 
 392 | HIDE_SCOPE_NAMES       = YES
 393 | 
 394 | # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen 
 395 | # will put a list of the files that are included by a file in the documentation 
 396 | # of that file.
 397 | 
 398 | SHOW_INCLUDE_FILES     = YES
 399 | 
 400 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen 
 401 | # will list include files with double quotes in the documentation 
 402 | # rather than with sharp brackets.
 403 | 
 404 | FORCE_LOCAL_INCLUDES   = NO
 405 | 
 406 | # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] 
 407 | # is inserted in the documentation for inline members.
 408 | 
 409 | INLINE_INFO            = YES
 410 | 
 411 | # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen 
 412 | # will sort the (detailed) documentation of file and class members 
 413 | # alphabetically by member name. If set to NO the members will appear in 
 414 | # declaration order.
 415 | 
 416 | SORT_MEMBER_DOCS       = YES
 417 | 
 418 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the 
 419 | # brief documentation of file, namespace and class members alphabetically 
 420 | # by member name. If set to NO (the default) the members will appear in 
 421 | # declaration order.
 422 | 
 423 | SORT_BRIEF_DOCS        = NO
 424 | 
 425 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen 
 426 | # will sort the (brief and detailed) documentation of class members so that 
 427 | # constructors and destructors are listed first. If set to NO (the default) 
 428 | # the constructors will appear in the respective orders defined by 
 429 | # SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. 
 430 | # This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO 
 431 | # and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
 432 | 
 433 | SORT_MEMBERS_CTORS_1ST = NO
 434 | 
 435 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the 
 436 | # hierarchy of group names into alphabetical order. If set to NO (the default) 
 437 | # the group names will appear in their defined order.
 438 | 
 439 | SORT_GROUP_NAMES       = NO
 440 | 
 441 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
 442 | # sorted by fully-qualified names, including namespaces. If set to 
 443 | # NO (the default), the class list will be sorted only by class name, 
 444 | # not including the namespace part. 
 445 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 
 446 | # Note: This option applies only to the class list, not to the 
 447 | # alphabetical list.
 448 | 
 449 | SORT_BY_SCOPE_NAME     = NO
 450 | 
 451 | # The GENERATE_TODOLIST tag can be used to enable (YES) or 
 452 | # disable (NO) the todo list. This list is created by putting \todo 
 453 | # commands in the documentation.
 454 | 
 455 | GENERATE_TODOLIST      = YES
 456 | 
 457 | # The GENERATE_TESTLIST tag can be used to enable (YES) or 
 458 | # disable (NO) the test list. This list is created by putting \test 
 459 | # commands in the documentation.
 460 | 
 461 | GENERATE_TESTLIST      = YES
 462 | 
 463 | # The GENERATE_BUGLIST tag can be used to enable (YES) or 
 464 | # disable (NO) the bug list. This list is created by putting \bug 
 465 | # commands in the documentation.
 466 | 
 467 | GENERATE_BUGLIST       = YES
 468 | 
 469 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or 
 470 | # disable (NO) the deprecated list. This list is created by putting 
 471 | # \deprecated commands in the documentation.
 472 | 
 473 | GENERATE_DEPRECATEDLIST= YES
 474 | 
 475 | # The ENABLED_SECTIONS tag can be used to enable conditional 
 476 | # documentation sections, marked by \if sectionname ... \endif.
 477 | 
 478 | ENABLED_SECTIONS       = 
 479 | 
 480 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines 
 481 | # the initial value of a variable or define consists of for it to appear in 
 482 | # the documentation. If the initializer consists of more lines than specified 
 483 | # here it will be hidden. Use a value of 0 to hide initializers completely. 
 484 | # The appearance of the initializer of individual variables and defines in the 
 485 | # documentation can be controlled using \showinitializer or \hideinitializer 
 486 | # command in the documentation regardless of this setting.
 487 | 
 488 | MAX_INITIALIZER_LINES  = 30
 489 | 
 490 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated 
 491 | # at the bottom of the documentation of classes and structs. If set to YES the 
 492 | # list will mention the files that were used to generate the documentation.
 493 | 
 494 | SHOW_USED_FILES        = YES
 495 | 
 496 | # If the sources in your project are distributed over multiple directories 
 497 | # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy 
 498 | # in the documentation. The default is NO.
 499 | 
 500 | SHOW_DIRECTORIES       = NO
 501 | 
 502 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. 
 503 | # This will remove the Files entry from the Quick Index and from the 
 504 | # Folder Tree View (if specified). The default is YES.
 505 | 
 506 | SHOW_FILES             = YES
 507 | 
 508 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the 
 509 | # Namespaces page.  This will remove the Namespaces entry from the Quick Index 
 510 | # and from the Folder Tree View (if specified). The default is YES.
 511 | 
 512 | SHOW_NAMESPACES        = YES
 513 | 
 514 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 
 515 | # doxygen should invoke to get the current version for each file (typically from 
 516 | # the version control system). Doxygen will invoke the program by executing (via 
 517 | # popen()) the command <command> <input-file>, where <command> is the value of 
 518 | # the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file 
 519 | # provided by doxygen. Whatever the program writes to standard output 
 520 | # is used as the file version. See the manual for examples.
 521 | 
 522 | FILE_VERSION_FILTER    = 
 523 | 
 524 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 
 525 | # by doxygen. The layout file controls the global structure of the generated 
 526 | # output files in an output format independent way. The create the layout file 
 527 | # that represents doxygen's defaults, run doxygen with the -l option. 
 528 | # You can optionally specify a file name after the option, if omitted 
 529 | # DoxygenLayout.xml will be used as the name of the layout file.
 530 | 
 531 | LAYOUT_FILE            = 
 532 | 
 533 | #---------------------------------------------------------------------------
 534 | # configuration options related to warning and progress messages
 535 | #---------------------------------------------------------------------------
 536 | 
 537 | # The QUIET tag can be used to turn on/off the messages that are generated 
 538 | # by doxygen. Possible values are YES and NO. If left blank NO is used.
 539 | 
 540 | QUIET                  = NO
 541 | 
 542 | # The WARNINGS tag can be used to turn on/off the warning messages that are 
 543 | # generated by doxygen. Possible values are YES and NO. If left blank 
 544 | # NO is used.
 545 | 
 546 | WARNINGS               = YES
 547 | 
 548 | # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings 
 549 | # for undocumented members. If EXTRACT_ALL is set to YES then this flag will 
 550 | # automatically be disabled.
 551 | 
 552 | WARN_IF_UNDOCUMENTED   = YES
 553 | 
 554 | # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for 
 555 | # potential errors in the documentation, such as not documenting some 
 556 | # parameters in a documented function, or documenting parameters that 
 557 | # don't exist or using markup commands wrongly.
 558 | 
 559 | WARN_IF_DOC_ERROR      = YES
 560 | 
 561 | # This WARN_NO_PARAMDOC option can be abled to get warnings for 
 562 | # functions that are documented, but have no documentation for their parameters 
 563 | # or return value. If set to NO (the default) doxygen will only warn about 
 564 | # wrong or incomplete parameter documentation, but not about the absence of 
 565 | # documentation.
 566 | 
 567 | WARN_NO_PARAMDOC       = NO
 568 | 
 569 | # The WARN_FORMAT tag determines the format of the warning messages that 
 570 | # doxygen can produce. The string should contain the $file, $line, and $text 
 571 | # tags, which will be replaced by the file and line number from which the 
 572 | # warning originated and the warning text. Optionally the format may contain 
 573 | # $version, which will be replaced by the version of the file (if it could 
 574 | # be obtained via FILE_VERSION_FILTER)
 575 | 
 576 | WARN_FORMAT            = "$file:$line: $text"
 577 | 
 578 | # The WARN_LOGFILE tag can be used to specify a file to which warning 
 579 | # and error messages should be written. If left blank the output is written 
 580 | # to stderr.
 581 | 
 582 | WARN_LOGFILE           = 
 583 | 
 584 | #---------------------------------------------------------------------------
 585 | # configuration options related to the input files
 586 | #---------------------------------------------------------------------------
 587 | 
 588 | # The INPUT tag can be used to specify the files and/or directories that contain 
 589 | # documented source files. You may enter file names like "myfile.cpp" or 
 590 | # directories like "/usr/src/myproject". Separate the files or directories 
 591 | # with spaces.
 592 | 
 593 | INPUT                  = .
 594 | 
 595 | # This tag can be used to specify the character encoding of the source files 
 596 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
 597 | # also the default input encoding. Doxygen uses libiconv (or the iconv built 
 598 | # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for 
 599 | # the list of possible encodings.
 600 | 
 601 | INPUT_ENCODING         = UTF-8
 602 | 
 603 | # If the value of the INPUT tag contains directories, you can use the 
 604 | # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
 605 | # and *.h) to filter out the source-files in the directories. If left 
 606 | # blank the following patterns are tested: 
 607 | # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx 
 608 | # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
 609 | 
 610 | FILE_PATTERNS          = *.php \ *.module \ *.inc \ *.install \ *.js \ *.theme
 611 | 
 612 | # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
 613 | # should be searched for input files as well. Possible values are YES and NO. 
 614 | # If left blank NO is used.
 615 | 
 616 | RECURSIVE              = YES
 617 | 
 618 | # The EXCLUDE tag can be used to specify files and/or directories that should 
 619 | # excluded from the INPUT source files. This way you can easily exclude a 
 620 | # subdirectory from a directory tree whose root is specified with the INPUT tag.
 621 | 
 622 | EXCLUDE                = 
 623 | 
 624 | # The EXCLUDE_SYMLINKS tag can be used select whether or not files or 
 625 | # directories that are symbolic links (a Unix filesystem feature) are excluded 
 626 | # from the input.
 627 | 
 628 | EXCLUDE_SYMLINKS       = NO
 629 | 
 630 | # If the value of the INPUT tag contains directories, you can use the 
 631 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 
 632 | # certain files from those directories. Note that the wildcards are matched 
 633 | # against the file with absolute path, so to exclude all test directories 
 634 | # for example use the pattern */test/*
 635 | 
 636 | EXCLUDE_PATTERNS       = 
 637 | 
 638 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 
 639 | # (namespaces, classes, functions, etc.) that should be excluded from the 
 640 | # output. The symbol name can be a fully qualified name, a word, or if the 
 641 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 
 642 | # AClass::ANamespace, ANamespace::*Test
 643 | 
 644 | EXCLUDE_SYMBOLS        = 
 645 | 
 646 | # The EXAMPLE_PATH tag can be used to specify one or more files or 
 647 | # directories that contain example code fragments that are included (see 
 648 | # the \include command).
 649 | 
 650 | EXAMPLE_PATH           = 
 651 | 
 652 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
 653 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
 654 | # and *.h) to filter out the source-files in the directories. If left 
 655 | # blank all files are included.
 656 | 
 657 | EXAMPLE_PATTERNS       = *
 658 | 
 659 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 
 660 | # searched for input files to be used with the \include or \dontinclude 
 661 | # commands irrespective of the value of the RECURSIVE tag. 
 662 | # Possible values are YES and NO. If left blank NO is used.
 663 | 
 664 | EXAMPLE_RECURSIVE      = NO
 665 | 
 666 | # The IMAGE_PATH tag can be used to specify one or more files or 
 667 | # directories that contain image that are included in the documentation (see 
 668 | # the \image command).
 669 | 
 670 | IMAGE_PATH             = 
 671 | 
 672 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 
 673 | # invoke to filter for each input file. Doxygen will invoke the filter program 
 674 | # by executing (via popen()) the command <filter> <input-file>, where <filter> 
 675 | # is the value of the INPUT_FILTER tag, and <input-file> is the name of an 
 676 | # input file. Doxygen will then use the output that the filter program writes 
 677 | # to standard output.  If FILTER_PATTERNS is specified, this tag will be 
 678 | # ignored.
 679 | 
 680 | INPUT_FILTER           = 
 681 | 
 682 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 
 683 | # basis.  Doxygen will compare the file name with each pattern and apply the 
 684 | # filter if there is a match.  The filters are a list of the form: 
 685 | # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further 
 686 | # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER 
 687 | # is applied to all files.
 688 | 
 689 | FILTER_PATTERNS        = 
 690 | 
 691 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 
 692 | # INPUT_FILTER) will be used to filter the input files when producing source 
 693 | # files to browse (i.e. when SOURCE_BROWSER is set to YES).
 694 | 
 695 | FILTER_SOURCE_FILES    = NO
 696 | 
 697 | #---------------------------------------------------------------------------
 698 | # configuration options related to source browsing
 699 | #---------------------------------------------------------------------------
 700 | 
 701 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will 
 702 | # be generated. Documented entities will be cross-referenced with these sources. 
 703 | # Note: To get rid of all source code in the generated output, make sure also 
 704 | # VERBATIM_HEADERS is set to NO.
 705 | 
 706 | SOURCE_BROWSER         = YES
 707 | 
 708 | # Setting the INLINE_SOURCES tag to YES will include the body 
 709 | # of functions and classes directly in the documentation.
 710 | 
 711 | INLINE_SOURCES         = NO
 712 | 
 713 | # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct 
 714 | # doxygen to hide any special comment blocks from generated source code 
 715 | # fragments. Normal C and C++ comments will always remain visible.
 716 | 
 717 | STRIP_CODE_COMMENTS    = NO
 718 | 
 719 | # If the REFERENCED_BY_RELATION tag is set to YES 
 720 | # then for each documented function all documented 
 721 | # functions referencing it will be listed.
 722 | 
 723 | REFERENCED_BY_RELATION = YES
 724 | 
 725 | # If the REFERENCES_RELATION tag is set to YES 
 726 | # then for each documented function all documented entities 
 727 | # called/used by that function will be listed.
 728 | 
 729 | REFERENCES_RELATION    = YES
 730 | 
 731 | # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) 
 732 | # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from 
 733 | # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will 
 734 | # link to the source code.  Otherwise they will link to the documentation.
 735 | 
 736 | REFERENCES_LINK_SOURCE = YES
 737 | 
 738 | # If the USE_HTAGS tag is set to YES then the references to source code 
 739 | # will point to the HTML generated by the htags(1) tool instead of doxygen 
 740 | # built-in source browser. The htags tool is part of GNU's global source 
 741 | # tagging system (see http://www.gnu.org/software/global/global.html). You 
 742 | # will need version 4.8.6 or higher.
 743 | 
 744 | USE_HTAGS              = NO
 745 | 
 746 | # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen 
 747 | # will generate a verbatim copy of the header file for each class for 
 748 | # which an include is specified. Set to NO to disable this.
 749 | 
 750 | VERBATIM_HEADERS       = YES
 751 | 
 752 | #---------------------------------------------------------------------------
 753 | # configuration options related to the alphabetical class index
 754 | #---------------------------------------------------------------------------
 755 | 
 756 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index 
 757 | # of all compounds will be generated. Enable this if the project 
 758 | # contains a lot of classes, structs, unions or interfaces.
 759 | 
 760 | ALPHABETICAL_INDEX     = YES
 761 | 
 762 | # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then 
 763 | # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns 
 764 | # in which this list will be split (can be a number in the range [1..20])
 765 | 
 766 | COLS_IN_ALPHA_INDEX    = 5
 767 | 
 768 | # In case all classes in a project start with a common prefix, all 
 769 | # classes will be put under the same header in the alphabetical index. 
 770 | # The IGNORE_PREFIX tag can be used to specify one or more prefixes that 
 771 | # should be ignored while generating the index headers.
 772 | 
 773 | IGNORE_PREFIX          = 
 774 | 
 775 | #---------------------------------------------------------------------------
 776 | # configuration options related to the HTML output
 777 | #---------------------------------------------------------------------------
 778 | 
 779 | # If the GENERATE_HTML tag is set to YES (the default) Doxygen will 
 780 | # generate HTML output.
 781 | 
 782 | GENERATE_HTML          = YES
 783 | 
 784 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. 
 785 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
 786 | # put in front of it. If left blank `html' will be used as the default path.
 787 | 
 788 | HTML_OUTPUT            = html
 789 | 
 790 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for 
 791 | # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
 792 | # doxygen will generate files with .html extension.
 793 | 
 794 | HTML_FILE_EXTENSION    = .html
 795 | 
 796 | # The HTML_HEADER tag can be used to specify a personal HTML header for 
 797 | # each generated HTML page. If it is left blank doxygen will generate a 
 798 | # standard header.
 799 | 
 800 | HTML_HEADER            = 
 801 | 
 802 | # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
 803 | # each generated HTML page. If it is left blank doxygen will generate a 
 804 | # standard footer.
 805 | 
 806 | HTML_FOOTER            = 
 807 | 
 808 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading 
 809 | # style sheet that is used by each HTML page. It can be used to 
 810 | # fine-tune the look of the HTML output. If the tag is left blank doxygen 
 811 | # will generate a default style sheet. Note that doxygen will try to copy 
 812 | # the style sheet file to the HTML output directory, so don't put your own 
 813 | # stylesheet in the HTML output directory as well, or it will be erased!
 814 | 
 815 | HTML_STYLESHEET        = 
 816 | 
 817 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. 
 818 | # Doxygen will adjust the colors in the stylesheet and background images 
 819 | # according to this color. Hue is specified as an angle on a colorwheel, 
 820 | # see http://en.wikipedia.org/wiki/Hue for more information. 
 821 | # For instance the value 0 represents red, 60 is yellow, 120 is green, 
 822 | # 180 is cyan, 240 is blue, 300 purple, and 360 is red again. 
 823 | # The allowed range is 0 to 359.
 824 | 
 825 | HTML_COLORSTYLE_HUE    = 220
 826 | 
 827 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of 
 828 | # the colors in the HTML output. For a value of 0 the output will use 
 829 | # grayscales only. A value of 255 will produce the most vivid colors.
 830 | 
 831 | HTML_COLORSTYLE_SAT    = 100
 832 | 
 833 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to 
 834 | # the luminance component of the colors in the HTML output. Values below 
 835 | # 100 gradually make the output lighter, whereas values above 100 make 
 836 | # the output darker. The value divided by 100 is the actual gamma applied, 
 837 | # so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, 
 838 | # and 100 does not change the gamma.
 839 | 
 840 | HTML_COLORSTYLE_GAMMA  = 80
 841 | 
 842 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 
 843 | # page will contain the date and time when the page was generated. Setting 
 844 | # this to NO can help when comparing the output of multiple runs.
 845 | 
 846 | HTML_TIMESTAMP         = YES
 847 | 
 848 | # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
 849 | # files or namespaces will be aligned in HTML using tables. If set to 
 850 | # NO a bullet list will be used.
 851 | 
 852 | HTML_ALIGN_MEMBERS     = YES
 853 | 
 854 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 
 855 | # documentation will contain sections that can be hidden and shown after the 
 856 | # page has loaded. For this to work a browser that supports 
 857 | # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox 
 858 | # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
 859 | 
 860 | HTML_DYNAMIC_SECTIONS  = NO
 861 | 
 862 | # If the GENERATE_DOCSET tag is set to YES, additional index files 
 863 | # will be generated that can be used as input for Apple's Xcode 3 
 864 | # integrated development environment, introduced with OSX 10.5 (Leopard). 
 865 | # To create a documentation set, doxygen will generate a Makefile in the 
 866 | # HTML output directory. Running make will produce the docset in that 
 867 | # directory and running "make install" will install the docset in 
 868 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find 
 869 | # it at startup. 
 870 | # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 
 871 | # for more information.
 872 | 
 873 | GENERATE_DOCSET        = NO
 874 | 
 875 | # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
 876 | # feed. A documentation feed provides an umbrella under which multiple 
 877 | # documentation sets from a single provider (such as a company or product suite) 
 878 | # can be grouped.
 879 | 
 880 | DOCSET_FEEDNAME        = "Doxygen generated docs"
 881 | 
 882 | # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
 883 | # should uniquely identify the documentation set bundle. This should be a 
 884 | # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
 885 | # will append .docset to the name.
 886 | 
 887 | DOCSET_BUNDLE_ID       = org.doxygen.Project
 888 | 
 889 | # When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify 
 890 | # the documentation publisher. This should be a reverse domain-name style 
 891 | # string, e.g. com.mycompany.MyDocSet.documentation.
 892 | 
 893 | DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
 894 | 
 895 | # The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
 896 | 
 897 | DOCSET_PUBLISHER_NAME  = Publisher
 898 | 
 899 | # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
 900 | # will be generated that can be used as input for tools like the 
 901 | # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) 
 902 | # of the generated HTML documentation.
 903 | 
 904 | GENERATE_HTMLHELP      = NO
 905 | 
 906 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can 
 907 | # be used to specify the file name of the resulting .chm file. You 
 908 | # can add a path in front of the file if the result should not be 
 909 | # written to the html output directory.
 910 | 
 911 | CHM_FILE               = 
 912 | 
 913 | # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can 
 914 | # be used to specify the location (absolute path including file name) of 
 915 | # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run 
 916 | # the HTML help compiler on the generated index.hhp.
 917 | 
 918 | HHC_LOCATION           = 
 919 | 
 920 | # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag 
 921 | # controls if a separate .chi index file is generated (YES) or that 
 922 | # it should be included in the master .chm file (NO).
 923 | 
 924 | GENERATE_CHI           = NO
 925 | 
 926 | # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING 
 927 | # is used to encode HtmlHelp index (hhk), content (hhc) and project file 
 928 | # content.
 929 | 
 930 | CHM_INDEX_ENCODING     = 
 931 | 
 932 | # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag 
 933 | # controls whether a binary table of contents is generated (YES) or a 
 934 | # normal table of contents (NO) in the .chm file.
 935 | 
 936 | BINARY_TOC             = NO
 937 | 
 938 | # The TOC_EXPAND flag can be set to YES to add extra items for group members 
 939 | # to the contents of the HTML help documentation and to the tree view.
 940 | 
 941 | TOC_EXPAND             = NO
 942 | 
 943 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 
 944 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated 
 945 | # that can be used as input for Qt's qhelpgenerator to generate a 
 946 | # Qt Compressed Help (.qch) of the generated HTML documentation.
 947 | 
 948 | GENERATE_QHP           = NO
 949 | 
 950 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can 
 951 | # be used to specify the file name of the resulting .qch file. 
 952 | # The path specified is relative to the HTML output folder.
 953 | 
 954 | QCH_FILE               = 
 955 | 
 956 | # The QHP_NAMESPACE tag specifies the namespace to use when generating 
 957 | # Qt Help Project output. For more information please see 
 958 | # http://doc.trolltech.com/qthelpproject.html#namespace
 959 | 
 960 | QHP_NAMESPACE          = org.doxygen.Project
 961 | 
 962 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
 963 | # Qt Help Project output. For more information please see 
 964 | # http://doc.trolltech.com/qthelpproject.html#virtual-folders
 965 | 
 966 | QHP_VIRTUAL_FOLDER     = doc
 967 | 
 968 | # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to 
 969 | # add. For more information please see 
 970 | # http://doc.trolltech.com/qthelpproject.html#custom-filters
 971 | 
 972 | QHP_CUST_FILTER_NAME   = 
 973 | 
 974 | # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the 
 975 | # custom filter to add. For more information please see 
 976 | # <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters"> 
 977 | # Qt Help Project / Custom Filters</a>.
 978 | 
 979 | QHP_CUST_FILTER_ATTRS  = 
 980 | 
 981 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 
 982 | # project's 
 983 | # filter section matches. 
 984 | # <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes"> 
 985 | # Qt Help Project / Filter Attributes</a>.
 986 | 
 987 | QHP_SECT_FILTER_ATTRS  = 
 988 | 
 989 | # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can 
 990 | # be used to specify the location of Qt's qhelpgenerator. 
 991 | # If non-empty doxygen will try to run qhelpgenerator on the generated 
 992 | # .qhp file.
 993 | 
 994 | QHG_LOCATION           = 
 995 | 
 996 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files  
 997 | # will be generated, which together with the HTML files, form an Eclipse help 
 998 | # plugin. To install this plugin and make it available under the help contents 
 999 | # menu in Eclipse, the contents of the directory containing the HTML and XML 
1000 | # files needs to be copied into the plugins directory of eclipse. The name of 
1001 | # the directory within the plugins directory should be the same as 
1002 | # the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before 
1003 | # the help appears.
1004 | 
1005 | GENERATE_ECLIPSEHELP   = NO
1006 | 
1007 | # A unique identifier for the eclipse help plugin. When installing the plugin 
1008 | # the directory name containing the HTML and XML files should also have 
1009 | # this name.
1010 | 
1011 | ECLIPSE_DOC_ID         = org.doxygen.Project
1012 | 
1013 | # The DISABLE_INDEX tag can be used to turn on/off the condensed index at 
1014 | # top of each HTML page. The value NO (the default) enables the index and 
1015 | # the value YES disables it.
1016 | 
1017 | DISABLE_INDEX          = NO
1018 | 
1019 | # This tag can be used to set the number of enum values (range [1..20]) 
1020 | # that doxygen will group on one line in the generated HTML documentation.
1021 | 
1022 | ENUM_VALUES_PER_LINE   = 4
1023 | 
1024 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 
1025 | # structure should be generated to display hierarchical information. 
1026 | # If the tag value is set to YES, a side panel will be generated 
1027 | # containing a tree-like index structure (just like the one that 
1028 | # is generated for HTML Help). For this to work a browser that supports 
1029 | # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). 
1030 | # Windows users are probably better off using the HTML help feature.
1031 | 
1032 | GENERATE_TREEVIEW      = YES
1033 | 
1034 | # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, 
1035 | # and Class Hierarchy pages using a tree view instead of an ordered list.
1036 | 
1037 | USE_INLINE_TREES       = NO
1038 | 
1039 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
1040 | # used to set the initial width (in pixels) of the frame in which the tree 
1041 | # is shown.
1042 | 
1043 | TREEVIEW_WIDTH         = 250
1044 | 
1045 | # When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open 
1046 | # links to external symbols imported via tag files in a separate window.
1047 | 
1048 | EXT_LINKS_IN_WINDOW    = NO
1049 | 
1050 | # Use this tag to change the font size of Latex formulas included 
1051 | # as images in the HTML documentation. The default is 10. Note that 
1052 | # when you change the font size after a successful doxygen run you need 
1053 | # to manually remove any form_*.png images from the HTML output directory 
1054 | # to force them to be regenerated.
1055 | 
1056 | FORMULA_FONTSIZE       = 10
1057 | 
1058 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 
1059 | # generated for formulas are transparent PNGs. Transparent PNGs are 
1060 | # not supported properly for IE 6.0, but are supported on all modern browsers. 
1061 | # Note that when changing this option you need to delete any form_*.png files 
1062 | # in the HTML output before the changes have effect.
1063 | 
1064 | FORMULA_TRANSPARENT    = YES
1065 | 
1066 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box 
1067 | # for the HTML output. The underlying search engine uses javascript 
1068 | # and DHTML and should work on any modern browser. Note that when using 
1069 | # HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets 
1070 | # (GENERATE_DOCSET) there is already a search function so this one should 
1071 | # typically be disabled. For large projects the javascript based search engine 
1072 | # can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
1073 | 
1074 | SEARCHENGINE           = YES
1075 | 
1076 | # When the SERVER_BASED_SEARCH tag is enabled the search engine will be 
1077 | # implemented using a PHP enabled web server instead of at the web client 
1078 | # using Javascript. Doxygen will generate the search PHP script and index 
1079 | # file to put on the web server. The advantage of the server 
1080 | # based approach is that it scales better to large projects and allows 
1081 | # full text search. The disadvances is that it is more difficult to setup 
1082 | # and does not have live searching capabilities.
1083 | 
1084 | SERVER_BASED_SEARCH    = NO
1085 | 
1086 | #---------------------------------------------------------------------------
1087 | # configuration options related to the LaTeX output
1088 | #---------------------------------------------------------------------------
1089 | 
1090 | # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
1091 | # generate Latex output.
1092 | 
1093 | GENERATE_LATEX         = NO
1094 | 
1095 | # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
1096 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1097 | # put in front of it. If left blank `latex' will be used as the default path.
1098 | 
1099 | LATEX_OUTPUT           = latex
1100 | 
1101 | # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be 
1102 | # invoked. If left blank `latex' will be used as the default command name. 
1103 | # Note that when enabling USE_PDFLATEX this option is only used for 
1104 | # generating bitmaps for formulas in the HTML output, but not in the 
1105 | # Makefile that is written to the output directory.
1106 | 
1107 | LATEX_CMD_NAME         = latex
1108 | 
1109 | # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to 
1110 | # generate index for LaTeX. If left blank `makeindex' will be used as the 
1111 | # default command name.
1112 | 
1113 | MAKEINDEX_CMD_NAME     = makeindex
1114 | 
1115 | # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact 
1116 | # LaTeX documents. This may be useful for small projects and may help to 
1117 | # save some trees in general.
1118 | 
1119 | COMPACT_LATEX          = NO
1120 | 
1121 | # The PAPER_TYPE tag can be used to set the paper type that is used 
1122 | # by the printer. Possible values are: a4, a4wide, letter, legal and 
1123 | # executive. If left blank a4wide will be used.
1124 | 
1125 | PAPER_TYPE             = a4wide
1126 | 
1127 | # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX 
1128 | # packages that should be included in the LaTeX output.
1129 | 
1130 | EXTRA_PACKAGES         = 
1131 | 
1132 | # The LATEX_HEADER tag can be used to specify a personal LaTeX header for 
1133 | # the generated latex document. The header should contain everything until 
1134 | # the first chapter. If it is left blank doxygen will generate a 
1135 | # standard header. Notice: only use this tag if you know what you are doing!
1136 | 
1137 | LATEX_HEADER           = 
1138 | 
1139 | # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated 
1140 | # is prepared for conversion to pdf (using ps2pdf). The pdf file will 
1141 | # contain links (just like the HTML output) instead of page references 
1142 | # This makes the output suitable for online browsing using a pdf viewer.
1143 | 
1144 | PDF_HYPERLINKS         = YES
1145 | 
1146 | # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of 
1147 | # plain latex in the generated Makefile. Set this option to YES to get a 
1148 | # higher quality PDF documentation.
1149 | 
1150 | USE_PDFLATEX           = YES
1151 | 
1152 | # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. 
1153 | # command to the generated LaTeX files. This will instruct LaTeX to keep 
1154 | # running if errors occur, instead of asking the user for help. 
1155 | # This option is also used when generating formulas in HTML.
1156 | 
1157 | LATEX_BATCHMODE        = NO
1158 | 
1159 | # If LATEX_HIDE_INDICES is set to YES then doxygen will not 
1160 | # include the index chapters (such as File Index, Compound Index, etc.) 
1161 | # in the output.
1162 | 
1163 | LATEX_HIDE_INDICES     = NO
1164 | 
1165 | # If LATEX_SOURCE_CODE is set to YES then doxygen will include 
1166 | # source code with syntax highlighting in the LaTeX output. 
1167 | # Note that which sources are shown also depends on other settings 
1168 | # such as SOURCE_BROWSER.
1169 | 
1170 | LATEX_SOURCE_CODE      = YES
1171 | 
1172 | #---------------------------------------------------------------------------
1173 | # configuration options related to the RTF output
1174 | #---------------------------------------------------------------------------
1175 | 
1176 | # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output 
1177 | # The RTF output is optimized for Word 97 and may not look very pretty with 
1178 | # other RTF readers or editors.
1179 | 
1180 | GENERATE_RTF           = NO
1181 | 
1182 | # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. 
1183 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1184 | # put in front of it. If left blank `rtf' will be used as the default path.
1185 | 
1186 | RTF_OUTPUT             = rtf
1187 | 
1188 | # If the COMPACT_RTF tag is set to YES Doxygen generates more compact 
1189 | # RTF documents. This may be useful for small projects and may help to 
1190 | # save some trees in general.
1191 | 
1192 | COMPACT_RTF            = NO
1193 | 
1194 | # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated 
1195 | # will contain hyperlink fields. The RTF file will 
1196 | # contain links (just like the HTML output) instead of page references. 
1197 | # This makes the output suitable for online browsing using WORD or other 
1198 | # programs which support those fields. 
1199 | # Note: wordpad (write) and others do not support links.
1200 | 
1201 | RTF_HYPERLINKS         = NO
1202 | 
1203 | # Load stylesheet definitions from file. Syntax is similar to doxygen's 
1204 | # config file, i.e. a series of assignments. You only have to provide 
1205 | # replacements, missing definitions are set to their default value.
1206 | 
1207 | RTF_STYLESHEET_FILE    = 
1208 | 
1209 | # Set optional variables used in the generation of an rtf document. 
1210 | # Syntax is similar to doxygen's config file.
1211 | 
1212 | RTF_EXTENSIONS_FILE    = 
1213 | 
1214 | #---------------------------------------------------------------------------
1215 | # configuration options related to the man page output
1216 | #---------------------------------------------------------------------------
1217 | 
1218 | # If the GENERATE_MAN tag is set to YES (the default) Doxygen will 
1219 | # generate man pages
1220 | 
1221 | GENERATE_MAN           = NO
1222 | 
1223 | # The MAN_OUTPUT tag is used to specify where the man pages will be put. 
1224 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1225 | # put in front of it. If left blank `man' will be used as the default path.
1226 | 
1227 | MAN_OUTPUT             = man
1228 | 
1229 | # The MAN_EXTENSION tag determines the extension that is added to 
1230 | # the generated man pages (default is the subroutine's section .3)
1231 | 
1232 | MAN_EXTENSION          = .3
1233 | 
1234 | # If the MAN_LINKS tag is set to YES and Doxygen generates man output, 
1235 | # then it will generate one additional man file for each entity 
1236 | # documented in the real man page(s). These additional files 
1237 | # only source the real man page, but without them the man command 
1238 | # would be unable to find the correct page. The default is NO.
1239 | 
1240 | MAN_LINKS              = NO
1241 | 
1242 | #---------------------------------------------------------------------------
1243 | # configuration options related to the XML output
1244 | #---------------------------------------------------------------------------
1245 | 
1246 | # If the GENERATE_XML tag is set to YES Doxygen will 
1247 | # generate an XML file that captures the structure of 
1248 | # the code including all documentation.
1249 | 
1250 | GENERATE_XML           = NO
1251 | 
1252 | # The XML_OUTPUT tag is used to specify where the XML pages will be put. 
1253 | # If a relative path is entered the value of OUTPUT_DIRECTORY will be 
1254 | # put in front of it. If left blank `xml' will be used as the default path.
1255 | 
1256 | XML_OUTPUT             = xml
1257 | 
1258 | # The XML_SCHEMA tag can be used to specify an XML schema, 
1259 | # which can be used by a validating XML parser to check the 
1260 | # syntax of the XML files.
1261 | 
1262 | XML_SCHEMA             = 
1263 | 
1264 | # The XML_DTD tag can be used to specify an XML DTD, 
1265 | # which can be used by a validating XML parser to check the 
1266 | # syntax of the XML files.
1267 | 
1268 | XML_DTD                = 
1269 | 
1270 | # If the XML_PROGRAMLISTING tag is set to YES Doxygen will 
1271 | # dump the program listings (including syntax highlighting 
1272 | # and cross-referencing information) to the XML output. Note that 
1273 | # enabling this will significantly increase the size of the XML output.
1274 | 
1275 | XML_PROGRAMLISTING     = YES
1276 | 
1277 | #---------------------------------------------------------------------------
1278 | # configuration options for the AutoGen Definitions output
1279 | #---------------------------------------------------------------------------
1280 | 
1281 | # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will 
1282 | # generate an AutoGen Definitions (see autogen.sf.net) file 
1283 | # that captures the structure of the code including all 
1284 | # documentation. Note that this feature is still experimental 
1285 | # and incomplete at the moment.
1286 | 
1287 | GENERATE_AUTOGEN_DEF   = NO
1288 | 
1289 | #---------------------------------------------------------------------------
1290 | # configuration options related to the Perl module output
1291 | #---------------------------------------------------------------------------
1292 | 
1293 | # If the GENERATE_PERLMOD tag is set to YES Doxygen will 
1294 | # generate a Perl module file that captures the structure of 
1295 | # the code including all documentation. Note that this 
1296 | # feature is still experimental and incomplete at the 
1297 | # moment.
1298 | 
1299 | GENERATE_PERLMOD       = NO
1300 | 
1301 | # If the PERLMOD_LATEX tag is set to YES Doxygen will generate 
1302 | # the necessary Makefile rules, Perl scripts and LaTeX code to be able 
1303 | # to generate PDF and DVI output from the Perl module output.
1304 | 
1305 | PERLMOD_LATEX          = NO
1306 | 
1307 | # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be 
1308 | # nicely formatted so it can be parsed by a human reader.  This is useful 
1309 | # if you want to understand what is going on.  On the other hand, if this 
1310 | # tag is set to NO the size of the Perl module output will be much smaller 
1311 | # and Perl will parse it just the same.
1312 | 
1313 | PERLMOD_PRETTY         = YES
1314 | 
1315 | # The names of the make variables in the generated doxyrules.make file 
1316 | # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. 
1317 | # This is useful so different doxyrules.make files included by the same 
1318 | # Makefile don't overwrite each other's variables.
1319 | 
1320 | PERLMOD_MAKEVAR_PREFIX = 
1321 | 
1322 | #---------------------------------------------------------------------------
1323 | # Configuration options related to the preprocessor
1324 | #---------------------------------------------------------------------------
1325 | 
1326 | # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will 
1327 | # evaluate all C-preprocessor directives found in the sources and include 
1328 | # files.
1329 | 
1330 | ENABLE_PREPROCESSING   = YES
1331 | 
1332 | # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro 
1333 | # names in the source code. If set to NO (the default) only conditional 
1334 | # compilation will be performed. Macro expansion can be done in a controlled 
1335 | # way by setting EXPAND_ONLY_PREDEF to YES.
1336 | 
1337 | MACRO_EXPANSION        = NO
1338 | 
1339 | # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
1340 | # then the macro expansion is limited to the macros specified with the 
1341 | # PREDEFINED and EXPAND_AS_DEFINED tags.
1342 | 
1343 | EXPAND_ONLY_PREDEF     = NO
1344 | 
1345 | # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
1346 | # in the INCLUDE_PATH (see below) will be search if a #include is found.
1347 | 
1348 | SEARCH_INCLUDES        = YES
1349 | 
1350 | # The INCLUDE_PATH tag can be used to specify one or more directories that 
1351 | # contain include files that are not input files but should be processed by 
1352 | # the preprocessor.
1353 | 
1354 | INCLUDE_PATH           = 
1355 | 
1356 | # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
1357 | # patterns (like *.h and *.hpp) to filter out the header-files in the 
1358 | # directories. If left blank, the patterns specified with FILE_PATTERNS will 
1359 | # be used.
1360 | 
1361 | INCLUDE_FILE_PATTERNS  = 
1362 | 
1363 | # The PREDEFINED tag can be used to specify one or more macro names that 
1364 | # are defined before the preprocessor is started (similar to the -D option of 
1365 | # gcc). The argument of the tag is a list of macros of the form: name 
1366 | # or name=definition (no spaces). If the definition and the = are 
1367 | # omitted =1 is assumed. To prevent a macro definition from being 
1368 | # undefined via #undef or recursively expanded use the := operator 
1369 | # instead of the = operator.
1370 | 
1371 | PREDEFINED             = 
1372 | 
1373 | # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
1374 | # this tag can be used to specify a list of macro names that should be expanded. 
1375 | # The macro definition that is found in the sources will be used. 
1376 | # Use the PREDEFINED tag if you want to use a different macro definition.
1377 | 
1378 | EXPAND_AS_DEFINED      = 
1379 | 
1380 | # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then 
1381 | # doxygen's preprocessor will remove all function-like macros that are alone 
1382 | # on a line, have an all uppercase name, and do not end with a semicolon. Such 
1383 | # function macros are typically used for boiler-plate code, and will confuse 
1384 | # the parser if not removed.
1385 | 
1386 | SKIP_FUNCTION_MACROS   = YES
1387 | 
1388 | #---------------------------------------------------------------------------
1389 | # Configuration::additions related to external references
1390 | #---------------------------------------------------------------------------
1391 | 
1392 | # The TAGFILES option can be used to specify one or more tagfiles. 
1393 | # Optionally an initial location of the external documentation 
1394 | # can be added for each tagfile. The format of a tag file without 
1395 | # this location is as follows: 
1396 | #   TAGFILES = file1 file2 ... 
1397 | # Adding location for the tag files is done as follows: 
1398 | #   TAGFILES = file1=loc1 "file2 = loc2" ... 
1399 | # where "loc1" and "loc2" can be relative or absolute paths or 
1400 | # URLs. If a location is present for each tag, the installdox tool 
1401 | # does not have to be run to correct the links. 
1402 | # Note that each tag file must have a unique name 
1403 | # (where the name does NOT include the path) 
1404 | # If a tag file is not located in the directory in which doxygen 
1405 | # is run, you must also specify the path to the tagfile here.
1406 | 
1407 | TAGFILES               = 
1408 | 
1409 | # When a file name is specified after GENERATE_TAGFILE, doxygen will create 
1410 | # a tag file that is based on the input files it reads.
1411 | 
1412 | GENERATE_TAGFILE       = 
1413 | 
1414 | # If the ALLEXTERNALS tag is set to YES all external classes will be listed 
1415 | # in the class index. If set to NO only the inherited external classes 
1416 | # will be listed.
1417 | 
1418 | ALLEXTERNALS           = NO
1419 | 
1420 | # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed 
1421 | # in the modules index. If set to NO, only the current project's groups will 
1422 | # be listed.
1423 | 
1424 | EXTERNAL_GROUPS        = YES
1425 | 
1426 | # The PERL_PATH should be the absolute path and name of the perl script 
1427 | # interpreter (i.e. the result of `which perl').
1428 | 
1429 | PERL_PATH              = /usr/bin/perl
1430 | 
1431 | #---------------------------------------------------------------------------
1432 | # Configuration options related to the dot tool
1433 | #---------------------------------------------------------------------------
1434 | 
1435 | # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will 
1436 | # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base 
1437 | # or super classes. Setting the tag to NO turns the diagrams off. Note that 
1438 | # this option is superseded by the HAVE_DOT option below. This is only a 
1439 | # fallback. It is recommended to install and use dot, since it yields more 
1440 | # powerful graphs.
1441 | 
1442 | CLASS_DIAGRAMS         = YES
1443 | 
1444 | # You can define message sequence charts within doxygen comments using the \msc 
1445 | # command. Doxygen will then run the mscgen tool (see 
1446 | # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the 
1447 | # documentation. The MSCGEN_PATH tag allows you to specify the directory where 
1448 | # the mscgen tool resides. If left empty the tool is assumed to be found in the 
1449 | # default search path.
1450 | 
1451 | MSCGEN_PATH            = 
1452 | 
1453 | # If set to YES, the inheritance and collaboration graphs will hide 
1454 | # inheritance and usage relations if the target is undocumented 
1455 | # or is not a class.
1456 | 
1457 | HIDE_UNDOC_RELATIONS   = YES
1458 | 
1459 | # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is 
1460 | # available from the path. This tool is part of Graphviz, a graph visualization 
1461 | # toolkit from AT&T and Lucent Bell Labs. The other options in this section 
1462 | # have no effect if this option is set to NO (the default)
1463 | 
1464 | HAVE_DOT               = NO
1465 | 
1466 | # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is 
1467 | # allowed to run in parallel. When set to 0 (the default) doxygen will 
1468 | # base this on the number of processors available in the system. You can set it 
1469 | # explicitly to a value larger than 0 to get control over the balance 
1470 | # between CPU load and processing speed.
1471 | 
1472 | DOT_NUM_THREADS        = 0
1473 | 
1474 | # By default doxygen will write a font called FreeSans.ttf to the output 
1475 | # directory and reference it in all dot files that doxygen generates. This 
1476 | # font does not include all possible unicode characters however, so when you need 
1477 | # these (or just want a differently looking font) you can specify the font name 
1478 | # using DOT_FONTNAME. You need need to make sure dot is able to find the font, 
1479 | # which can be done by putting it in a standard location or by setting the 
1480 | # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory 
1481 | # containing the font.
1482 | 
1483 | DOT_FONTNAME           = FreeSans.ttf
1484 | 
1485 | # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. 
1486 | # The default size is 10pt.
1487 | 
1488 | DOT_FONTSIZE           = 10
1489 | 
1490 | # By default doxygen will tell dot to use the output directory to look for the 
1491 | # FreeSans.ttf font (which doxygen will put there itself). If you specify a 
1492 | # different font using DOT_FONTNAME you can set the path where dot 
1493 | # can find it using this tag.
1494 | 
1495 | DOT_FONTPATH           = 
1496 | 
1497 | # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1498 | # will generate a graph for each documented class showing the direct and 
1499 | # indirect inheritance relations. Setting this tag to YES will force the 
1500 | # the CLASS_DIAGRAMS tag to NO.
1501 | 
1502 | CLASS_GRAPH            = YES
1503 | 
1504 | # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen 
1505 | # will generate a graph for each documented class showing the direct and 
1506 | # indirect implementation dependencies (inheritance, containment, and 
1507 | # class references variables) of the class with other documented classes.
1508 | 
1509 | COLLABORATION_GRAPH    = YES
1510 | 
1511 | # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen 
1512 | # will generate a graph for groups, showing the direct groups dependencies
1513 | 
1514 | GROUP_GRAPHS           = YES
1515 | 
1516 | # If the UML_LOOK tag is set to YES doxygen will generate inheritance and 
1517 | # collaboration diagrams in a style similar to the OMG's Unified Modeling 
1518 | # Language.
1519 | 
1520 | UML_LOOK               = NO
1521 | 
1522 | # If set to YES, the inheritance and collaboration graphs will show the 
1523 | # relations between templates and their instances.
1524 | 
1525 | TEMPLATE_RELATIONS     = NO
1526 | 
1527 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT 
1528 | # tags are set to YES then doxygen will generate a graph for each documented 
1529 | # file showing the direct and indirect include dependencies of the file with 
1530 | # other documented files.
1531 | 
1532 | INCLUDE_GRAPH          = YES
1533 | 
1534 | # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and 
1535 | # HAVE_DOT tags are set to YES then doxygen will generate a graph for each 
1536 | # documented header file showing the documented files that directly or 
1537 | # indirectly include this file.
1538 | 
1539 | INCLUDED_BY_GRAPH      = YES
1540 | 
1541 | # If the CALL_GRAPH and HAVE_DOT options are set to YES then 
1542 | # doxygen will generate a call dependency graph for every global function 
1543 | # or class method. Note that enabling this option will significantly increase 
1544 | # the time of a run. So in most cases it will be better to enable call graphs 
1545 | # for selected functions only using the \callgraph command.
1546 | 
1547 | CALL_GRAPH             = NO
1548 | 
1549 | # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then 
1550 | # doxygen will generate a caller dependency graph for every global function 
1551 | # or class method. Note that enabling this option will significantly increase 
1552 | # the time of a run. So in most cases it will be better to enable caller 
1553 | # graphs for selected functions only using the \callergraph command.
1554 | 
1555 | CALLER_GRAPH           = NO
1556 | 
1557 | # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen 
1558 | # will graphical hierarchy of all classes instead of a textual one.
1559 | 
1560 | GRAPHICAL_HIERARCHY    = YES
1561 | 
1562 | # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES 
1563 | # then doxygen will show the dependencies a directory has on other directories 
1564 | # in a graphical way. The dependency relations are determined by the #include 
1565 | # relations between the files in the directories.
1566 | 
1567 | DIRECTORY_GRAPH        = YES
1568 | 
1569 | # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images 
1570 | # generated by dot. Possible values are png, jpg, or gif 
1571 | # If left blank png will be used.
1572 | 
1573 | DOT_IMAGE_FORMAT       = png
1574 | 
1575 | # The tag DOT_PATH can be used to specify the path where the dot tool can be 
1576 | # found. If left blank, it is assumed the dot tool can be found in the path.
1577 | 
1578 | DOT_PATH               = 
1579 | 
1580 | # The DOTFILE_DIRS tag can be used to specify one or more directories that 
1581 | # contain dot files that are included in the documentation (see the 
1582 | # \dotfile command).
1583 | 
1584 | DOTFILE_DIRS           = 
1585 | 
1586 | # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of 
1587 | # nodes that will be shown in the graph. If the number of nodes in a graph 
1588 | # becomes larger than this value, doxygen will truncate the graph, which is 
1589 | # visualized by representing a node as a red box. Note that doxygen if the 
1590 | # number of direct children of the root node in a graph is already larger than 
1591 | # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note 
1592 | # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
1593 | 
1594 | DOT_GRAPH_MAX_NODES    = 50
1595 | 
1596 | # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the 
1597 | # graphs generated by dot. A depth value of 3 means that only nodes reachable 
1598 | # from the root by following a path via at most 3 edges will be shown. Nodes 
1599 | # that lay further from the root node will be omitted. Note that setting this 
1600 | # option to 1 or 2 may greatly reduce the computation time needed for large 
1601 | # code bases. Also note that the size of a graph can be further restricted by 
1602 | # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
1603 | 
1604 | MAX_DOT_GRAPH_DEPTH    = 0
1605 | 
1606 | # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent 
1607 | # background. This is disabled by default, because dot on Windows does not 
1608 | # seem to support this out of the box. Warning: Depending on the platform used, 
1609 | # enabling this option may lead to badly anti-aliased labels on the edges of 
1610 | # a graph (i.e. they become hard to read).
1611 | 
1612 | DOT_TRANSPARENT        = NO
1613 | 
1614 | # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output 
1615 | # files in one run (i.e. multiple -o and -T options on the command line). This 
1616 | # makes dot run faster, but since only newer versions of dot (>1.8.10) 
1617 | # support this, this feature is disabled by default.
1618 | 
1619 | DOT_MULTI_TARGETS      = NO
1620 | 
1621 | # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will 
1622 | # generate a legend page explaining the meaning of the various boxes and 
1623 | # arrows in the dot generated graphs.
1624 | 
1625 | GENERATE_LEGEND        = YES
1626 | 
1627 | # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will 
1628 | # remove the intermediate dot files that are used to generate 
1629 | # the various graphs.
1630 | 
1631 | DOT_CLEANUP            = YES
1632 | 


--------------------------------------------------------------------------------