Commit 545f0a4e authored by jcnventura's avatar jcnventura

doxygen improvements.

parent 532ebda4
...@@ -10,8 +10,7 @@ ...@@ -10,8 +10,7 @@
/** /**
* @defgroup print Printer, email and PDF versions * @defgroup print Printer, email and PDF versions
* *
* Welcome to the print module developer's documentation. The interesting * Files used by the print module, grouped by sub-module
* functions for themers are those that start with 'theme_'.
* *
* - Printer-friendly pages * - Printer-friendly pages
* - @link print.module Module main file @endlink * - @link print.module Module main file @endlink
...@@ -24,11 +23,27 @@ ...@@ -24,11 +23,27 @@
* - @link print_mail.admin.inc Settings form @endlink * - @link print_mail.admin.inc Settings form @endlink
* - @link print_mail.inc Mail form and send mail routine @endlink * - @link print_mail.inc Mail form and send mail routine @endlink
* - @link print_mail.install (Un)Install routines @endlink * - @link print_mail.install (Un)Install routines @endlink
* - @link views_handler_sort_print_mail_sentcount.inc Views handler @endlink
* - PDF version * - PDF version
* - @link print_pdf.module Module main file @endlink * - @link print_pdf.module Module main file @endlink
* - @link print_pdf.admin.inc Settings form @endlink * - @link print_pdf.admin.inc Settings form @endlink
* - @link print_pdf.pages.inc PDF generation @endlink * - @link print_pdf.pages.inc PDF generation @endlink
* - @link print_pdf.class.inc Auxiliary PHP5 class @endlink * - @link print_pdf.class.inc Auxiliary PHP5 class @endlink
* - @link print_pdf.class_php4.inc Auxiliary PHP4 class @endlink
* - @link print_pdf.install (Un)Install routines @endlink * - @link print_pdf.install (Un)Install routines @endlink
* - @link print_pdf.drush.inc Drush commands @endlink
* - User Interface (Links)
* - @link print_ui.module Module main file @endlink
* - @link print_ui.admin.inc Settings form @endlink
*/
/**
* @defgroup print_hooks Hooks
*
* Hooks used in the print module
*/
/**
* @defgroup print_themeable Themeable functions
*
* Default theme implementations of the print module
*/ */
...@@ -192,6 +192,7 @@ function print_preprocess_print(&$variables) { ...@@ -192,6 +192,7 @@ function print_preprocess_print(&$variables) {
* HTML text with the published line * HTML text with the published line
* *
* @ingroup themeable * @ingroup themeable
* @ingroup print_themeable
*/ */
function theme_print_published($vars) { function theme_print_published($vars) {
global $base_url; global $base_url;
...@@ -211,6 +212,7 @@ function theme_print_published($vars) { ...@@ -211,6 +212,7 @@ function theme_print_published($vars) {
* HTML text with the breadcrumb * HTML text with the breadcrumb
* *
* @ingroup themeable * @ingroup themeable
* @ingroup print_themeable
*/ */
function theme_print_breadcrumb($vars) { function theme_print_breadcrumb($vars) {
$node = $vars['node']; $node = $vars['node'];
...@@ -240,6 +242,7 @@ function theme_print_breadcrumb($vars) { ...@@ -240,6 +242,7 @@ function theme_print_breadcrumb($vars) {
* HTML text with the footer * HTML text with the footer
* *
* @ingroup themeable * @ingroup themeable
* @ingroup print_themeable
*/ */
function theme_print_footer($vars) { function theme_print_footer($vars) {
$footer = ''; $footer = '';
...@@ -269,6 +272,7 @@ function theme_print_footer($vars) { ...@@ -269,6 +272,7 @@ function theme_print_footer($vars) {
* HTML text with the footer * HTML text with the footer
* *
* @ingroup themeable * @ingroup themeable
* @ingroup print_themeable
*/ */
function theme_print_sourceurl($vars) { function theme_print_sourceurl($vars) {
$sourceurl_date = variable_get('print_sourceurl_date', PRINT_SOURCEURL_DATE_DEFAULT); $sourceurl_date = variable_get('print_sourceurl_date', PRINT_SOURCEURL_DATE_DEFAULT);
...@@ -298,6 +302,7 @@ function theme_print_sourceurl($vars) { ...@@ -298,6 +302,7 @@ function theme_print_sourceurl($vars) {
* HTML text with the URL list * HTML text with the URL list
* *
* @ingroup themeable * @ingroup themeable
* @ingroup print_themeable
*/ */
function theme_print_url_list($vars) { function theme_print_url_list($vars) {
global $_print_urls; global $_print_urls;
......
...@@ -184,6 +184,7 @@ function print_mail_form($form, &$form_state) { ...@@ -184,6 +184,7 @@ function print_mail_form($form, &$form_state) {
* @see print_mail_form() * @see print_mail_form()
* @ingroup forms * @ingroup forms
* @ingroup themeable * @ingroup themeable
* @ingroup print_themeable
*/ */
function theme_print_mail_form($form) { function theme_print_mail_form($form) {
drupal_add_css(drupal_get_path('module', 'print_mail') . '/css/print_mail.theme.css'); drupal_add_css(drupal_get_path('module', 'print_mail') . '/css/print_mail.theme.css');
......
...@@ -132,6 +132,7 @@ function print_ui_settings() { ...@@ -132,6 +132,7 @@ function print_ui_settings() {
* - form: A render element representing the form. * - form: A render element representing the form.
* *
* @ingroup themeable * @ingroup themeable
* @ingroup print_themeable
*/ */
function theme_print_ui_settings($variables) { function theme_print_ui_settings($variables) {
$form = $variables['form']; $form = $variables['form'];
......
...@@ -5,10 +5,6 @@ ...@@ -5,10 +5,6 @@
* Hooks provided by the Print UI module. * Hooks provided by the Print UI module.
*/ */
/**
* @defgroup print_hooks Print Hooks
*/
/** /**
* @addtogroup hooks * @addtogroup hooks
* @{ * @{
...@@ -72,6 +68,8 @@ function hook_print_link() { ...@@ -72,6 +68,8 @@ function hook_print_link() {
* *
* @return bool * @return bool
* FALSE if not allowed, TRUE otherwise * FALSE if not allowed, TRUE otherwise
*
* @ingroup print_hooks
*/ */
function hook_link_allowed($args) { function hook_link_allowed($args) {
return (user_access('access foo')); return (user_access('access foo'));
...@@ -89,6 +87,8 @@ function hook_link_allowed($args) { ...@@ -89,6 +87,8 @@ function hook_link_allowed($args) {
* - node: path to the node beign displayed. * - node: path to the node beign displayed.
* - view_mode: current view mode of the node being displayed. * - view_mode: current view mode of the node being displayed.
* - type: 'node' or 'comment'. * - type: 'node' or 'comment'.
*
* @ingroup print_hooks
*/ */
function hook_print_new_window_alter(&$new_window, $format) { function hook_print_new_window_alter(&$new_window, $format) {
if ($format == 'foo') { if ($format == 'foo') {
......
...@@ -466,6 +466,7 @@ function _print_ui_fill_attributes($title = '', $class = '', $new_window = FALSE ...@@ -466,6 +466,7 @@ function _print_ui_fill_attributes($title = '', $class = '', $new_window = FALSE
* *
* @see _print_ui_fill_attributes() * @see _print_ui_fill_attributes()
* @ingroup themeable * @ingroup themeable
* @ingroup print_themeable
*/ */
function theme_print_ui_format_link($vars) { function theme_print_ui_format_link($vars) {
$format = $vars['format']; $format = $vars['format'];
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment