Skip to content

GitLab

Commit d08475b8 authored by jcnventura's avatar jcnventura
Browse files
Options

Stop using @mainpage in API documentation comments

parent 83f92fc4
Hide whitespace changes
Inline Side-by-side
Showing with 56 additions and 33 deletions
api/index.php deleted 100644 → 0
View file @ 83f92fc4
<?php
// $Id$
/**
* @file
* Homepage of the print module API reference
*/
// * @page module-print modules/print: Printer, e-mail and PDF versions
/**
* @mainpage Printer, e-mail and PDF versions
* Welcome to the print module developer's documentation. The interesting
* functions for themers are those that start with 'theme_'.
*
* - Printer-friendly pages
* - @link print.module Module main file @endlink
* - @link print.admin.inc Settings form @endlink
* - @link print.pages.inc HTML generation @endlink
* - @link print.install (Un)Install routines @endlink
* - @link print.tpl.php Page generation template @endlink
* - Send by e-mail
* - @link print_mail.module Module main file @endlink
* - @link print_mail.admin.inc Settings form @endlink
* - @link print_mail.inc Mail form and send mail routine @endlink
* - @link print_mail.install (Un)Install routines @endlink
* - PDF version
* - @link print_pdf.module Module main file @endlink
* - @link print_pdf.admin.inc Settings form @endlink
* - @link print_pdf.pages.inc PDF generation @endlink
* - @link print_pdf.class.inc Auxiliary class @endlink
* - @link print_pdf.install (Un)Install routines @endlink
*/
print.admin.inc
View file @ d08475b8
......@@ -7,6 +7,8 @@
*
* This file is included by the core PF module, and includes the
* settings form.
*
* @ingroup print
*/
/**
......
print.install
View file @ d08475b8
......@@ -4,6 +4,8 @@
/**
* @file
* Install file of the print module
*
* @ingroup print
*/
/**
......
print.module
View file @ d08475b8
<?php
// $Id$
/**
* @defgroup print Printer, e-mail and PDF versions
*
* Welcome to the print module developer's documentation. The interesting
* functions for themers are those that start with 'theme_'.
*
* - Printer-friendly pages
* - @link print.module Module main file @endlink
* - @link print.admin.inc Settings form @endlink
* - @link print.pages.inc HTML generation @endlink
* - @link print.install (Un)Install routines @endlink
* - @link print.tpl.php Page generation template @endlink
* - Send by e-mail
* - @link print_mail.module Module main file @endlink
* - @link print_mail.admin.inc Settings form @endlink
* - @link print_mail.inc Mail form and send mail routine @endlink
* - @link print_mail.install (Un)Install routines @endlink
* - PDF version
* - @link print_pdf.module Module main file @endlink
* - @link print_pdf.admin.inc Settings form @endlink
* - @link print_pdf.pages.inc PDF generation @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
*/
/**
* @file
* Displays Printer-friendly versions of Drupal pages.
*
* This is the core module of the PF package, with the Drupal hooks
* and other administrative functions.
*
* @ingroup print
*/
define('PRINT_PATH', 'print');
......
print.pages.inc
View file @ d08475b8
......@@ -8,6 +8,8 @@
* This file is included by the core PF module, and includes all the
* functions necessary to generate a PF version of the original page
* in HTML format.
*
* @ingroup print
*/
$_print_urls = PRINT_URLS_DEFAULT;
......
print.tpl.php
View file @ d08475b8
......@@ -4,6 +4,8 @@
/**
* @file
* Default print module template
*
* @ingroup print
*/
?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
......
print_mail/print_mail.admin.inc
View file @ d08475b8
......@@ -7,6 +7,8 @@
*
* This file is included by the send by e-mail module, and includes the
* settings form.
*
* @ingroup print
*/
/**
......
print_mail/print_mail.inc
View file @ d08475b8
......@@ -7,6 +7,8 @@
*
* This file is included by the print_mail module and includes the
* mail form display, validation and submit hooks.
*
* @ingroup print
*/
require_once(DRUPAL_ROOT . '/' . drupal_get_path('module', 'print') . '/print.pages.inc');
......
print_mail/print_mail.install
View file @ d08475b8
......@@ -4,6 +4,8 @@
/**
* @file
* Install file of the print_mail module
*
* @ingroup print
*/
/**
......
print_mail/print_mail.module
View file @ d08475b8
......@@ -4,6 +4,8 @@
/**
* @file
* Displays Printer-friendly versions of Drupal pages.
*
* @ingroup print
*/
define('PRINTMAIL_PATH', 'printmail');
......
print_pdf/print_pdf.admin.inc
View file @ d08475b8
......@@ -7,6 +7,8 @@
*
* This file is included by the PDF version module, and includes the
* settings form.
*
* @ingroup print
*/
/**
......
print_pdf/print_pdf.class.inc
View file @ d08475b8
......@@ -6,6 +6,8 @@
* Extend the TCPDF class to be able to customize the Footer
*
* This file is included by the _print_pdf_tcpdf function
*
* @ingroup print
*/
class PrintTCPDF extends TCPDF {
......
print_pdf/print_pdf.install
View file @ d08475b8
......@@ -4,6 +4,8 @@
/**
* @file
* Install file of the print_pdf module
*
* @ingroup print
*/
/**
......
print_pdf/print_pdf.module
View file @ d08475b8
......@@ -4,6 +4,8 @@
/**
* @file
* Displays Printer-friendly versions of Drupal pages.
*
* @ingroup print
*/
define('PRINTPDF_PATH', 'printpdf');
......
print_pdf/print_pdf.pages.inc
View file @ d08475b8
......@@ -7,6 +7,8 @@
*
* This file is included by the print_pdf module and includes the
* functions that interface with the PDF generation packages.
*
* @ingroup print
*/
require_once(DRUPAL_ROOT . '/' . drupal_get_path('module', 'print') . '/print.pages.inc');
......
tests/print_basic.test
View file @ d08475b8
......@@ -6,6 +6,8 @@
* print module simpletest tests
*
* This file includes the defined tests for the print module.
*
* @ingroup print
*/
class PrintBasicTest extends DrupalWebTestCase {
......
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