Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
project
drupal
Commits
b78a9902
Commit
b78a9902
authored
Jan 08, 2008
by
Gábor Hojtsy
Browse files
#207569
by ScoutBaker (minor code style): clean up @see usage in phpdoc blocks
parent
0ab0b1d6
Changes
30
Hide whitespace changes
Inline
Side-by-side
includes/bootstrap.inc
View file @
b78a9902
...
...
@@ -37,8 +37,8 @@
/**
*
* Severity levels, as defined in RFC 3164 http://www.faqs.org/rfcs/rfc3164.html
* @see watchdog
* @see watchdog_severity_levels
* @see watchdog
()
* @see watchdog_severity_levels
()
*/
define
(
'WATCHDOG_EMERG'
,
0
);
// Emergency: system is unusable
define
(
'WATCHDOG_ALERT'
,
1
);
// Alert: action must be taken immediately
...
...
@@ -562,7 +562,7 @@ function drupal_load($type, $name) {
* fetch a fresh page on every request. This prevents authenticated
* users seeing locally cached pages that show them as logged out.
*
* @see page_set_cache
* @see page_set_cache
()
*/
function
drupal_page_header
()
{
header
(
"Expires: Sun, 19 Nov 1978 05:00:00 GMT"
);
...
...
@@ -712,7 +712,7 @@ function request_uri() {
* @param $link
* A link to associate with the message.
*
* @see watchdog_severity_levels
* @see watchdog_severity_levels
()
*/
function
watchdog
(
$type
,
$message
,
$variables
=
array
(),
$severity
=
WATCHDOG_NOTICE
,
$link
=
NULL
)
{
global
$user
,
$base_root
;
...
...
includes/database.inc
View file @
b78a9902
...
...
@@ -9,7 +9,7 @@
/**
* A hash value to check when outputting database errors, md5('DB_ERROR').
*
* @see drupal_error_handler
* @see drupal_error_handler
()
*/
define
(
'DB_ERROR'
,
'a515ac9c2796ca0e23adbe92c68fc9fc'
);
...
...
modules/aggregator/aggregator.admin.inc
View file @
b78a9902
...
...
@@ -49,8 +49,8 @@ function aggregator_view() {
* Form builder; Generate a form to add/edit feed sources.
*
* @ingroup forms
* @see aggregator_form_feed_validate()
.
* @see aggregator_form_feed_submit()
.
* @see aggregator_form_feed_validate()
* @see aggregator_form_feed_submit()
*/
function
aggregator_form_feed
(
&
$form_state
,
$edit
=
array
(
'refresh'
=>
900
,
'title'
=>
''
,
'url'
=>
''
,
'fid'
=>
NULL
))
{
$period
=
drupal_map_assoc
(
array
(
900
,
1800
,
3600
,
7200
,
10800
,
21600
,
32400
,
43200
,
64800
,
86400
,
172800
,
259200
,
604800
,
1209600
,
2419200
),
'format_interval'
);
...
...
@@ -202,7 +202,7 @@ function aggregator_admin_refresh_feed($feed) {
* Form builder; Configure the aggregator system.
*
* @ingroup forms
* @see system_settings_form()
.
* @see system_settings_form()
*/
function
aggregator_admin_settings
()
{
$items
=
array
(
0
=>
t
(
'none'
))
+
drupal_map_assoc
(
array
(
3
,
5
,
10
,
15
,
20
,
25
),
'_aggregator_items'
);
...
...
@@ -239,8 +239,8 @@ function aggregator_admin_settings() {
* Form builder; Generate a form to add/edit/delete aggregator categories.
*
* @ingroup forms
* @see aggregator_form_category_validate()
.
* @see aggregator_form_category_submit()
.
* @see aggregator_form_category_validate()
* @see aggregator_form_category_submit()
*/
function
aggregator_form_category
(
&
$form_state
,
$edit
=
array
(
'title'
=>
''
,
'description'
=>
''
,
'cid'
=>
NULL
))
{
$form
[
'title'
]
=
array
(
'#type'
=>
'textfield'
,
...
...
modules/aggregator/aggregator.pages.inc
View file @
b78a9902
...
...
@@ -138,8 +138,8 @@ function _aggregator_page_list($items, $op, $feed_source = '') {
* @return
* The form structure.
* @ingroup forms
* @see aggregator_categorize_items_validate()
.
* @see aggregator_categorize_items_submit()
.
* @see aggregator_categorize_items_validate()
* @see aggregator_categorize_items_submit()
*/
function
aggregator_categorize_items
(
$items
,
$feed_source
=
''
)
{
$form
[
'#submit'
][]
=
'aggregator_categorize_items_submit'
;
...
...
modules/book/book.admin.inc
View file @
b78a9902
...
...
@@ -187,7 +187,7 @@ function _book_admin_table_tree($tree, &$form) {
* Theme function for the book administration page form.
*
* @ingroup themeable
* @see book_admin_table()
.
* @see book_admin_table()
*/
function
theme_book_admin_table
(
$form
)
{
drupal_add_tabledrag
(
'book-outline'
,
'match'
,
'parent'
,
'book-plid'
,
'book-plid'
,
'book-mlid'
,
TRUE
,
MENU_MAX_DEPTH
-
2
);
...
...
modules/book/book.module
View file @
b78a9902
...
...
@@ -925,7 +925,7 @@ function book_export_traverse($tree, $visit_func) {
/**
* Generates printer-friendly HTML for a node.
*
* @see book_export_traverse()
.
* @see book_export_traverse()
*
* @param $node
* The node to generate output for.
...
...
modules/comment/comment.admin.inc
View file @
b78a9902
...
...
@@ -30,9 +30,9 @@ function comment_admin($type = 'new') {
* @return
* The form structure.
* @ingroup forms
* @see comment_admin_overview_validate()
.
* @see comment_admin_overview_submit()
.
* @see theme_comment_admin_overview()
.
* @see comment_admin_overview_validate()
* @see comment_admin_overview_submit()
* @see theme_comment_admin_overview()
*/
function
comment_admin_overview
(
$type
=
'new'
,
$arg
)
{
// build an 'Update options' form
...
...
@@ -161,7 +161,7 @@ function theme_comment_admin_overview($form) {
* @return
* TRUE if the comments should be deleted, FALSE otherwise.
* @ingroup forms
* @see comment_multiple_delete_confirm_submit()
.
* @see comment_multiple_delete_confirm_submit()
*/
function
comment_multiple_delete_confirm
(
&
$form_state
)
{
$edit
=
$form_state
[
'post'
];
...
...
@@ -235,7 +235,7 @@ function comment_delete($cid = NULL) {
* Form builder; Builds the confirmation form for deleting a single comment.
*
* @ingroup forms
* @see comment_confirm_delete_submit()
.
* @see comment_confirm_delete_submit()
*/
function
comment_confirm_delete
(
&
$form_state
,
$comment
)
{
$form
=
array
();
...
...
modules/comment/comment.module
View file @
b78a9902
...
...
@@ -1234,8 +1234,8 @@ function comment_validate($edit) {
* @param $title
* Not used.
* @ingroup forms
* @see comment_form_validate()
.
* @see comment_form_submit()
.
* @see comment_form_validate()
* @see comment_form_submit()
*/
function
comment_form
(
&
$form_state
,
$edit
,
$title
=
NULL
)
{
global
$user
;
...
...
modules/dblog/dblog.admin.inc
View file @
b78a9902
...
...
@@ -10,7 +10,7 @@
* dblog module settings form.
*
* @ingroup forms
* @see system_settings_form()
.
* @see system_settings_form()
*/
function
dblog_admin_settings
()
{
$form
[
'dblog_row_limit'
]
=
array
(
...
...
@@ -247,8 +247,8 @@ function _dblog_format_message($dblog) {
* Return form for dblog administration filters.
*
* @ingroup forms
* @see dblog_filter_form_submit()
.
* @see dblog_filter_form_validate()
.
* @see dblog_filter_form_submit()
* @see dblog_filter_form_validate()
*/
function
dblog_filter_form
()
{
$session
=
&
$_SESSION
[
'dblog_overview_filter'
];
...
...
modules/dblog/dblog.module
View file @
b78a9902
...
...
@@ -9,7 +9,7 @@
* recorded events containing usage and performance data, errors,
* warnings, and similar operational information.
*
* @see watchdog()
.
* @see watchdog()
*/
/**
...
...
modules/filter/filter.admin.inc
View file @
b78a9902
...
...
@@ -11,7 +11,7 @@
* one is the default.
*
* @ingroup forms
* @see filter_admin_overview_submit()
.
* @see filter_admin_overview_submit()
*/
function
filter_admin_overview
()
{
...
...
@@ -88,8 +88,8 @@ function filter_admin_format_page($format = NULL) {
* Generate a filter format form.
*
* @ingroup forms
* @see filter_admin_format_form_validate()
.
* @see filter_admin_format_form_submit()
.
* @see filter_admin_format_form_validate()
* @see filter_admin_format_form_submit()
*/
function
filter_admin_format_form
(
&
$form_state
,
$format
)
{
$default
=
(
$format
->
format
==
variable_get
(
'filter_default_format'
,
1
));
...
...
@@ -238,7 +238,7 @@ function filter_admin_format_form_submit($form, &$form_state) {
* Menu callback; confirm deletion of a format.
*
* @ingroup forms
* @see filter_admin_delete_submit()
.
* @see filter_admin_delete_submit()
*/
function
filter_admin_delete
()
{
$format
=
arg
(
4
);
...
...
@@ -335,8 +335,8 @@ function filter_admin_order_page($format) {
* Build the form for ordering filters for a format.
*
* @ingroup forms
* @see theme_filter_admin_order()
.
* @see filter_admin_order_submit()
.
* @see theme_filter_admin_order()
* @see filter_admin_order_submit()
*/
function
filter_admin_order
(
&
$form_state
,
$format
=
NULL
)
{
// Get list (with forced refresh).
...
...
modules/filter/filter.module
View file @
b78a9902
...
...
@@ -462,7 +462,7 @@ function check_markup($text, $format = FILTER_FORMAT_DEFAULT, $check = TRUE) {
* Generate a selector for choosing a format in a form.
*
* @ingroup forms
* @see filter_form_validate()
.
* @see filter_form_validate()
* @param $value
* The ID of the format that is currently selected.
* @param $weight
...
...
modules/forum/forum.admin.inc
View file @
b78a9902
...
...
@@ -25,7 +25,7 @@ function forum_form_main($type, $edit = array()) {
*
* @param $edit Associative array containing a forum term to be added or edited.
* @ingroup forms
* @see forum_form_submit()
.
* @see forum_form_submit()
*/
function
forum_form_forum
(
&
$form_state
,
$edit
=
array
())
{
$edit
+=
array
(
...
...
@@ -102,7 +102,7 @@ function forum_form_submit($form, &$form_state) {
*
* @param $edit Associative array containing a container term to be added or edited.
* @ingroup forms
* @see forum_form_submit()
.
* @see forum_form_submit()
*/
function
forum_form_container
(
&
$form_state
,
$edit
=
array
())
{
$edit
+=
array
(
...
...
@@ -183,7 +183,7 @@ function forum_confirm_delete_submit($form, &$form_state) {
/**
* Form builder for the forum settings page.
*
* @see system_settings_form()
.
* @see system_settings_form()
*/
function
forum_admin_settings
()
{
$form
=
array
();
...
...
modules/forum/forum.module
View file @
b78a9902
...
...
@@ -876,7 +876,7 @@ function template_preprocess_forum_icon(&$variables) {
* $variables contains $node.
*
* @see forum-topic-navigation.tpl.php
* @see theme_forum_topic_navigation
* @see theme_forum_topic_navigation
()
*/
function
template_preprocess_forum_topic_navigation
(
&
$variables
)
{
$output
=
''
;
...
...
@@ -911,7 +911,7 @@ function template_preprocess_forum_topic_navigation(&$variables) {
* $variables will contain: $topic
*
* @see forum-submitted.tpl.php
* @see theme_forum_submitted
* @see theme_forum_submitted
()
*/
function
template_preprocess_forum_submitted
(
&
$variables
)
{
$variables
[
'author'
]
=
isset
(
$variables
[
'topic'
]
->
uid
)
?
theme
(
'username'
,
$variables
[
'topic'
])
:
''
;
...
...
modules/node/node.module
View file @
b78a9902
...
...
@@ -2206,7 +2206,7 @@ function node_access_needs_rebuild($rebuild = NULL) {
* Note : As of Drupal 6, node access modules are not required to (and actually
* should not) call node_access_rebuild() in hook_enable/disable anymore.
*
* @see node_access_needs_rebuild
* @see node_access_needs_rebuild
()
*
* @param $batch_mode
* Set to TRUE to process in 'batch' mode, spawning processing over several
...
...
modules/openid/openid.pages.inc
View file @
b78a9902
...
...
@@ -55,7 +55,7 @@ function openid_user_identities($account) {
* Form builder; Add an OpenID identity.
*
* @ingroup forms
* @see openid_user_add_validate()
.
* @see openid_user_add_validate()
*/
function
openid_user_add
()
{
$form
[
'openid_url'
]
=
array
(
...
...
modules/path/path.admin.inc
View file @
b78a9902
...
...
@@ -81,8 +81,8 @@ function path_admin_edit($pid = 0) {
* Return a form for editing or creating an individual URL alias.
*
* @ingroup forms
* @see path_admin_form_validate()
.
* @see path_admin_form_submit()
.
* @see path_admin_form_validate()
* @see path_admin_form_submit()
*/
function
path_admin_form
(
&
$form_state
,
$edit
=
array
(
'src'
=>
''
,
'dst'
=>
''
,
'language'
=>
''
,
'pid'
=>
NULL
))
{
...
...
@@ -186,7 +186,7 @@ function path_admin_delete_confirm_submit($form, &$form_state) {
* Return a form to filter URL aliases.
*
* @ingroup forms
* @see path_admin_filter_form_submit()
.
* @see path_admin_filter_form_submit()
*/
function
path_admin_filter_form
(
&
$form_state
,
$keys
=
''
)
{
$form
[
'#attributes'
]
=
array
(
'class'
=>
'search-form'
);
...
...
modules/profile/profile.admin.inc
View file @
b78a9902
...
...
@@ -10,7 +10,7 @@
* Form builder to display a listing of all editable profile fields.
*
* @ingroup forms
* @see profile_admin_overview_submit()
.
* @see profile_admin_overview_submit()
*/
function
profile_admin_overview
()
{
$result
=
db_query
(
'SELECT title, name, type, category, fid, weight FROM {profile_fields} ORDER BY category, weight'
);
...
...
@@ -66,7 +66,7 @@ function profile_admin_overview() {
/**
* Submit hanlder to update changed profile field weights and categories.
*
* @see profile_admin_overview()
.
* @see profile_admin_overview()
*/
function
profile_admin_overview_submit
(
$form
,
&
$form_state
)
{
foreach
(
element_children
(
$form_state
[
'values'
])
as
$fid
)
{
...
...
@@ -88,7 +88,7 @@ function profile_admin_overview_submit($form, &$form_state) {
* Theme the profile field overview into a drag and drop enabled table.
*
* @ingroup themeable
* @see profile_admin_overview()
.
* @see profile_admin_overview()
*/
function
theme_profile_admin_overview
(
$form
)
{
drupal_add_css
(
drupal_get_path
(
'module'
,
'profile'
)
.
'/profile.css'
);
...
...
@@ -161,8 +161,8 @@ function theme_profile_admin_overview($form) {
* Menu callback: Generate a form to add/edit a user profile field.
*
* @ingroup forms
* @see profile_field_form_validate()
.
* @see profile_field_form_submit()
.
* @see profile_field_form_validate()
* @see profile_field_form_submit()
*/
function
profile_field_form
(
&
$form_state
,
$arg
=
NULL
)
{
if
(
arg
(
3
)
==
'edit'
)
{
...
...
modules/search/search.admin.inc
View file @
b78a9902
...
...
@@ -30,8 +30,8 @@ function search_wipe_confirm_submit(&$form, &$form_state) {
* Menu callback; displays the search module settings page.
*
* @ingroup forms
* @see system_settings_form()
.
* @see search_admin_settings_validate()
.
* @see system_settings_form()
* @see search_admin_settings_validate()
*/
function
search_admin_settings
()
{
// Collect some stats
...
...
modules/search/search.module
View file @
b78a9902
...
...
@@ -1049,8 +1049,8 @@ function search_form(&$form_state, $action = '', $keys = '', $type = NULL, $prom
* Form builder; Output a search form for the search block and the theme's search box.
*
* @ingroup forms
* @see search_box_form_submit()
.
* @see theme_search_box_form()
.
* @see search_box_form_submit()
* @see theme_search_box_form()
*/
function
search_box
(
&
$form_state
,
$form_id
)
{
$form
[
$form_id
]
=
array
(
...
...
Prev
1
2
Next
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment