From 97420ae5ea29d72de1b9316930037c8770dd88d6 Mon Sep 17 00:00:00 2001 From: Chip Bennett Date: Wed, 19 Oct 2011 10:57:49 -0500 Subject: [PATCH] Re: Issue #40 lots of phpDoc updates --- 404.php | 4 +- footer.php | 13 ++-- header.php | 6 +- index.php | 2 +- infobar.php | 110 +++------------------------- languages/oenology.po | 166 +++++++++++++++++++++--------------------- loop-footer.php | 2 +- loop-header.php | 2 +- loop.php | 14 ++-- page.php | 2 + post-aside.php | 4 +- post-audio.php | 6 +- post-chat.php | 4 +- post-entry-image.php | 89 +--------------------- post-entry.php | 21 +++--- post-footer.php | 10 +-- post-gallery.php | 9 ++- post-header.php | 14 ++-- post-image.php | 9 ++- post-link.php | 4 +- post-quote.php | 4 +- post-status.php | 4 +- post-video.php | 6 +- post.php | 7 +- sidebar-left.php | 4 +- sidebar-page.php | 12 +-- sidebar-right.php | 4 +- sidebar.php | 21 +++--- single.php | 4 +- site-header.php | 10 ++- 30 files changed, 227 insertions(+), 340 deletions(-) diff --git a/404.php b/404.php index c8f864f..35da580 100644 --- a/404.php +++ b/404.php @@ -5,6 +5,8 @@ * This file is the Error 404 Page template file, which is output whenever * the server encounters a "404 - file not found" error. * + * @uses oenology_hook_post_404() Defined in /functions/hooks.php + * * @link http://codex.wordpress.org/Function_Reference/get_header get_header() * @link http://codex.wordpress.org/Function_Reference/get_footer get_footer() * @link http://codex.wordpress.org/Function_Reference/get_sidebar get_sidebar() @@ -85,7 +87,7 @@ * via "sidebar.php", or in the Error 404 Page context only, via * "sidebar-404.php" */ -get_sidebar( oenology_get_context() ); +get_sidebar( '404' ); ?> - -display_name; will display e.g. "John Smith" - -*********************** -wp_loginout() ----------------------------------- -wp_loginout() is a WordPress function. -Codex reference: http://codex.wordpress.org/Function_Reference/wp_loginout - -wp_loginout() displays a login link if user is logged out, or a logout link if user is logged in. - -wp_loginout() accepts 1 argument: - - $redirect: redirect location after login/out. Defaults to no redirect (current location) - -*********************** -wp_register() ----------------------------------- -wp_register() is a WordPress function. -Codex reference: http://codex.wordpress.org/Function_Reference/wp_register - -wp_register() displays a registration link if user is logged out and user registration is -permitted; otherwise, displays a link to site admin (Dashboard) if user is logged in. - -wp_register() accepts 3 arguments: - - $before: string to display before link. Defaults to '
  • ' - - $after: string to display after link. Defaults to '
    • ' - - $echo: return result boolean (true/false). Defaults to 'true' - -Example: - returns the Registration or Site Admin link, without wrapping -in
  • tags. - -============================================================================= -*/ ?> \ No newline at end of file + \ No newline at end of file diff --git a/languages/oenology.po b/languages/oenology.po index ed7cb27..09a8058 100644 --- a/languages/oenology.po +++ b/languages/oenology.po @@ -2,8 +2,8 @@ msgid "" msgstr "" "Project-Id-Version: oenology\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2011-10-06 07:57-0600\n" -"PO-Revision-Date: 2011-10-06 08:01-0600\n" +"POT-Creation-Date: 2011-08-12 12:39-0600\n" +"PO-Revision-Date: 2011-08-12 12:40-0600\n" "Last-Translator: Chip Bennett \n" "Language-Team: \n" "MIME-Version: 1.0\n" @@ -18,272 +18,272 @@ msgstr "" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:416 -#: Dropbox\Development\git\oenology\master\functions/custom.php:416 +#: Dropbox\Development\git\oenology\master/functions/custom.php:406 +#: Dropbox\Development\git\oenology\master\functions/custom.php:406 msgid "An incidental remark; digression: a message that departs from the main subject." msgstr "An incidental remark; digression: a message that departs from the main subject." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:420 -#: Dropbox\Development\git\oenology\master\functions/custom.php:420 +#: Dropbox\Development\git\oenology\master/functions/custom.php:410 +#: Dropbox\Development\git\oenology\master\functions/custom.php:410 msgid "A sound, or a sound signal; Of or relating to audible sound; Of or relating to the broadcasting or reproduction of sound, especially high-fidelity reproduction." msgstr "A sound, or a sound signal; Of or relating to audible sound; Of or relating to the broadcasting or reproduction of sound, especially high-fidelity reproduction." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:424 -#: Dropbox\Development\git\oenology\master\functions/custom.php:424 +#: Dropbox\Development\git\oenology\master/functions/custom.php:414 +#: Dropbox\Development\git\oenology\master\functions/custom.php:414 msgid "Any kind of communication over the Internet; primarily direct one-on-one chat or text-based group chat (formally also known as synchronous conferencing), using tools such as instant messengers and Internet Relay Chat." msgstr "Any kind of communication over the Internet; primarily direct one-on-one chat or text-based group chat (formally also known as synchronous conferencing), using tools such as instant messengers and Internet Relay Chat." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:428 -#: Dropbox\Development\git\oenology\master\functions/custom.php:428 +#: Dropbox\Development\git\oenology\master/functions/custom.php:418 +#: Dropbox\Development\git\oenology\master\functions/custom.php:418 msgid "A collection of art for exhibition." msgstr "A collection of art for exhibition." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:432 -#: Dropbox\Development\git\oenology\master\functions/custom.php:432 +#: Dropbox\Development\git\oenology\master/functions/custom.php:422 +#: Dropbox\Development\git\oenology\master\functions/custom.php:422 msgid "picture: A visual representation (of an object or scene or person or abstraction) produced on a surface." msgstr "picture: A visual representation (of an object or scene or person or abstraction) produced on a surface." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:436 -#: Dropbox\Development\git\oenology\master\functions/custom.php:436 +#: Dropbox\Development\git\oenology\master/functions/custom.php:426 +#: Dropbox\Development\git\oenology\master\functions/custom.php:426 msgid "A reference to a document that the reader can directly follow, or that is followed automatically. The reference points to a whole document or to a specific element within a document." msgstr "A reference to a document that the reader can directly follow, or that is followed automatically. The reference points to a whole document or to a specific element within a document." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:440 -#: Dropbox\Development\git\oenology\master\functions/custom.php:440 +#: Dropbox\Development\git\oenology\master/functions/custom.php:430 +#: Dropbox\Development\git\oenology\master\functions/custom.php:430 msgid "A quotation, statement attributed to someone else; To refer to (part of) a statement that has been made by someone else." msgstr "A quotation, statement attributed to someone else; To refer to (part of) a statement that has been made by someone else." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:444 -#: Dropbox\Development\git\oenology\master\functions/custom.php:444 +#: Dropbox\Development\git\oenology\master/functions/custom.php:434 +#: Dropbox\Development\git\oenology\master\functions/custom.php:434 msgid "state or condition of affairs" msgstr "state or condition of affairs" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:448 -#: Dropbox\Development\git\oenology\master\functions/custom.php:448 +#: Dropbox\Development\git\oenology\master/functions/custom.php:438 +#: Dropbox\Development\git\oenology\master\functions/custom.php:438 msgid "A recording of both visual and audible components; Electronically capturing, recording, processing, storing, transmitting, and reconstructing a sequence of still images representing scenes in motion." msgstr "A recording of both visual and audible components; Electronically capturing, recording, processing, storing, transmitting, and reconstructing a sequence of still images representing scenes in motion." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:513 -#: Dropbox\Development\git\oenology\master\functions/custom.php:513 +#: Dropbox\Development\git\oenology\master/functions/custom.php:503 +#: Dropbox\Development\git\oenology\master\functions/custom.php:503 msgid "YouTube" msgstr "YouTube" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:518 -#: Dropbox\Development\git\oenology\master\functions/custom.php:518 +#: Dropbox\Development\git\oenology\master/functions/custom.php:508 +#: Dropbox\Development\git\oenology\master\functions/custom.php:508 msgid "MySpace" msgstr "MySpace" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:523 -#: Dropbox\Development\git\oenology\master\functions/custom.php:523 +#: Dropbox\Development\git\oenology\master/functions/custom.php:513 +#: Dropbox\Development\git\oenology\master\functions/custom.php:513 msgid "Linked-In" msgstr "Linked-In" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:528 -#: Dropbox\Development\git\oenology\master\functions/custom.php:528 +#: Dropbox\Development\git\oenology\master/functions/custom.php:518 +#: Dropbox\Development\git\oenology\master\functions/custom.php:518 msgid "Flickr" msgstr "Flickr" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:533 -#: Dropbox\Development\git\oenology\master\functions/custom.php:533 +#: Dropbox\Development\git\oenology\master/functions/custom.php:523 +#: Dropbox\Development\git\oenology\master\functions/custom.php:523 msgid "Facebook" msgstr "Facebook" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:538 -#: Dropbox\Development\git\oenology\master\functions/custom.php:538 +#: Dropbox\Development\git\oenology\master/functions/custom.php:528 +#: Dropbox\Development\git\oenology\master\functions/custom.php:528 msgid "Twitter" msgstr "Twitter" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:656 -#: Dropbox\Development\git\oenology\master\functions/custom.php:656 +#: Dropbox\Development\git\oenology\master/functions/custom.php:646 +#: Dropbox\Development\git\oenology\master\functions/custom.php:646 msgid "Oh no, not again." msgstr "Oh no, not again." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:659 -#: Dropbox\Development\git\oenology\master\functions/custom.php:659 +#: Dropbox\Development\git\oenology\master/functions/custom.php:649 +#: Dropbox\Development\git\oenology\master\functions/custom.php:649 msgid "Well, this is weird." msgstr "Well, this is weird." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:660 -#: Dropbox\Development\git\oenology\master\functions/custom.php:660 +#: Dropbox\Development\git\oenology\master/functions/custom.php:650 +#: Dropbox\Development\git\oenology\master\functions/custom.php:650 msgid "The post, page, or file you requested could not be found. " msgstr "The post, page, or file you requested could not be found. " #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:661 -#: Dropbox\Development\git\oenology\master\functions/custom.php:661 +#: Dropbox\Development\git\oenology\master/functions/custom.php:651 +#: Dropbox\Development\git\oenology\master\functions/custom.php:651 msgid "The best laid plans of mice, and all that. " msgstr "The best laid plans of mice, and all that. " #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:662 -#: Dropbox\Development\git\oenology\master\functions/custom.php:662 +#: Dropbox\Development\git\oenology\master/functions/custom.php:652 +#: Dropbox\Development\git\oenology\master\functions/custom.php:652 msgid "Those who study the complex interplay of cause and effect in the history of the Universe say that this sort of thing is going on all the time." msgstr "Those who study the complex interplay of cause and effect in the history of the Universe say that this sort of thing is going on all the time." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:665 -#: Dropbox\Development\git\oenology\master\functions/custom.php:665 +#: Dropbox\Development\git\oenology\master/functions/custom.php:655 +#: Dropbox\Development\git\oenology\master\functions/custom.php:655 msgid "I apologize for the inconvenience." msgstr "I apologize for the inconvenience." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:666 -#: Dropbox\Development\git\oenology\master\functions/custom.php:666 +#: Dropbox\Development\git\oenology\master/functions/custom.php:656 +#: Dropbox\Development\git\oenology\master\functions/custom.php:656 msgid "Let me try to make it up to you!" msgstr "Let me try to make it up to you!" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:706 -#: Dropbox\Development\git\oenology\master\functions/custom.php:706 +#: Dropbox\Development\git\oenology\master/functions/custom.php:696 +#: Dropbox\Development\git\oenology\master\functions/custom.php:696 msgid "Here is a list of posts that you might have been looking for:" msgstr "Here is a list of posts that you might have been looking for:" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:722 -#: Dropbox\Development\git\oenology\master/functions/custom.php:753 -#: Dropbox\Development\git\oenology\master\functions/custom.php:722 -#: Dropbox\Development\git\oenology\master\functions/custom.php:753 +#: Dropbox\Development\git\oenology\master/functions/custom.php:712 +#: Dropbox\Development\git\oenology\master/functions/custom.php:743 +#: Dropbox\Development\git\oenology\master\functions/custom.php:712 +#: Dropbox\Development\git\oenology\master\functions/custom.php:743 msgid "No excerpt available." msgstr "No excerpt available." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:737 -#: Dropbox\Development\git\oenology\master\functions/custom.php:737 +#: Dropbox\Development\git\oenology\master/functions/custom.php:727 +#: Dropbox\Development\git\oenology\master\functions/custom.php:727 msgid "Here is a list of pages that you might have been looking for:" msgstr "Here is a list of pages that you might have been looking for:" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:772 -#: Dropbox\Development\git\oenology\master\functions/custom.php:772 +#: Dropbox\Development\git\oenology\master/functions/custom.php:762 +#: Dropbox\Development\git\oenology\master\functions/custom.php:762 msgid "Perhaps you were looking for something in one of the following categories?" msgstr "Perhaps you were looking for something in one of the following categories?" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:787 -#: Dropbox\Development\git\oenology\master\functions/custom.php:787 +#: Dropbox\Development\git\oenology\master/functions/custom.php:777 +#: Dropbox\Development\git\oenology\master\functions/custom.php:777 msgid "Perhaps you were looking for something with one of the following tags?" msgstr "Perhaps you were looking for something with one of the following tags?" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:797 -#: Dropbox\Development\git\oenology\master\functions/custom.php:797 +#: Dropbox\Development\git\oenology\master/functions/custom.php:787 +#: Dropbox\Development\git\oenology\master\functions/custom.php:787 msgid "I apologize." msgstr "I apologize." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:798 -#: Dropbox\Development\git\oenology\master\functions/custom.php:798 +#: Dropbox\Development\git\oenology\master/functions/custom.php:788 +#: Dropbox\Development\git\oenology\master\functions/custom.php:788 msgid "For the life of me, I am unable to figure out what you were trying to find." msgstr "For the life of me, I am unable to figure out what you were trying to find." #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:799 -#: Dropbox\Development\git\oenology\master\functions/custom.php:799 +#: Dropbox\Development\git\oenology\master/functions/custom.php:789 +#: Dropbox\Development\git\oenology\master\functions/custom.php:789 msgid "Perhaps try searching, using the search form in the upper right-hand corner?" msgstr "Perhaps try searching, using the search form in the upper right-hand corner?" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:871 -#: Dropbox\Development\git\oenology\master/functions/custom.php:873 -#: Dropbox\Development\git\oenology\master\functions/custom.php:871 -#: Dropbox\Development\git\oenology\master\functions/custom.php:873 +#: Dropbox\Development\git\oenology\master/functions/custom.php:861 +#: Dropbox\Development\git\oenology\master/functions/custom.php:863 +#: Dropbox\Development\git\oenology\master\functions/custom.php:861 +#: Dropbox\Development\git\oenology\master\functions/custom.php:863 msgid "Category Archive: " msgstr "Category Archive: " #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:897 -#: Dropbox\Development\git\oenology\master\functions/custom.php:897 +#: Dropbox\Development\git\oenology\master/functions/custom.php:887 +#: Dropbox\Development\git\oenology\master\functions/custom.php:887 #, php-format msgid "Posts Published in: %s" msgstr "Posts Published in: %s" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:949 -#: Dropbox\Development\git\oenology\master\functions/custom.php:949 +#: Dropbox\Development\git\oenology\master/functions/custom.php:939 +#: Dropbox\Development\git\oenology\master\functions/custom.php:939 msgid "Search Results:" msgstr "Search Results:" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:954 -#: Dropbox\Development\git\oenology\master\functions/custom.php:954 +#: Dropbox\Development\git\oenology\master/functions/custom.php:944 +#: Dropbox\Development\git\oenology\master\functions/custom.php:944 msgid "Tag Archive:" msgstr "Tag Archive:" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:959 -#: Dropbox\Development\git\oenology\master\functions/custom.php:959 +#: Dropbox\Development\git\oenology\master/functions/custom.php:949 +#: Dropbox\Development\git\oenology\master\functions/custom.php:949 msgid "Posts Written by:" msgstr "Posts Written by:" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:964 -#: Dropbox\Development\git\oenology\master\functions/custom.php:964 +#: Dropbox\Development\git\oenology\master/functions/custom.php:954 +#: Dropbox\Development\git\oenology\master\functions/custom.php:954 msgid "Error 404:" msgstr "Error 404:" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:965 -#: Dropbox\Development\git\oenology\master\functions/custom.php:965 +#: Dropbox\Development\git\oenology\master/functions/custom.php:955 +#: Dropbox\Development\git\oenology\master\functions/custom.php:955 msgid "Page Not Found" msgstr "Page Not Found" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/custom.php:969 -#: Dropbox\Development\git\oenology\master\functions/custom.php:969 +#: Dropbox\Development\git\oenology\master/functions/custom.php:959 +#: Dropbox\Development\git\oenology\master\functions/custom.php:959 msgid "Post Format Archive:" msgstr "Post Format Archive:" @@ -1188,7 +1188,7 @@ msgstr "Powered by %s" #: U:\My #: Documents\My -#: Dropbox\Development\git\oenology\master/functions/wordpress-hooks.php:187 +#: Dropbox\Development\git\oenology\master/functions/wordpress-hooks.php:161 msgid "Untitled" msgstr "Untitled" diff --git a/loop-footer.php b/loop-footer.php index 1a88a4c..263dcc0 100644 --- a/loop-footer.php +++ b/loop-footer.php @@ -4,7 +4,7 @@ * * Contains Posts index pagination links * - * @uses oenology_hook_loop_footer() + * @uses oenology_hook_loop_footer() Defined in /functions/hooks.php * * @link http://codex.wordpress.org/Function_Reference/is_singular is_singular() * diff --git a/loop-header.php b/loop-header.php index c3b9d9d..a2ac585 100644 --- a/loop-header.php +++ b/loop-header.php @@ -7,7 +7,7 @@ * query, etc., as well as a description of the taxonomy, * if provided. * - * @uses function_name() + * @uses oenology_hook_loop_header() Defined in /functions/hooks.php * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/loop.php b/loop.php index df51164..65d3cc2 100644 --- a/loop.php +++ b/loop.php @@ -4,12 +4,14 @@ * * Contains Loop header, Loop content, and Loop footer. * - * @uses oenology_hook_loop_footer_after() - * @uses oenology_hook_loop_footer_before() - * @uses oenology_hook_loop_header_after() - * @uses oenology_hook_loop_header_before() - * @uses oenology_hook_post_after() - * @uses oenology_hook_post_before() + * @uses oenology_get_context() Defined in /functions/custom.php + * @uses oenology_hook_loop_footer_after() Defined in /functions/hooks.php + * @uses oenology_hook_loop_footer_before() Defined in /functions/hooks.php + * @uses oenology_hook_loop_header_after() Defined in /functions/hooks.php + * @uses oenology_hook_loop_header_before() Defined in /functions/hooks.php + * @uses oenology_hook_loop_no_posts() Defined in /functions/hooks.php + * @uses oenology_hook_post_after() Defined in /functions/hooks.php + * @uses oenology_hook_post_before() Defined in /functions/hooks.php * * @link http://codex.wordpress.org/Function_Reference/comments_open comments_open() * @link http://codex.wordpress.org/Function_Reference/comments_template comments_template() diff --git a/page.php b/page.php index 90769e0..b024001 100644 --- a/page.php +++ b/page.php @@ -5,6 +5,8 @@ * This file is the default Page template file, used to display static * Pages if no custom Page template is defined. * + * @uses oenology_get_current_page_layout() Defined in /functions/custom.php + * * @link http://codex.wordpress.org/Function_Reference/get_header get_header() * @link http://codex.wordpress.org/Function_Reference/get_footer get_footer() * @link http://codex.wordpress.org/Function_Reference/get_sidebar get_sidebar() diff --git a/post-aside.php b/post-aside.php index 8a627fb..48d3ac0 100644 --- a/post-aside.php +++ b/post-aside.php @@ -5,7 +5,9 @@ * * This file is called by Posts with the "Aside" Post Format * - * @uses get_template_part() + * @uses oenology_get_context() Defined in /functions/custom.php + * + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post-audio.php b/post-audio.php index 615eabd..feb62bd 100644 --- a/post-audio.php +++ b/post-audio.php @@ -5,7 +5,11 @@ * * This file is called by Posts with the "Audio" Post Format * - * @uses get_template_part() + * @uses oenology_get_context() Defined in /functions/custom.php + * @uses oenology_hook_post_header_metadata() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_taxonomies() Defined in /functions/hooks.php + * + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post-chat.php b/post-chat.php index 32dd3db..1457052 100644 --- a/post-chat.php +++ b/post-chat.php @@ -5,7 +5,9 @@ * * This file is called by Posts with the "Chat" Post Format * - * @uses get_template_part() + * @uses oenology_get_context() Defined in /functions/custom.php + * + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post-entry-image.php b/post-entry-image.php index 8b523c5..f8d99e2 100644 --- a/post-entry-image.php +++ b/post-entry-image.php @@ -5,7 +5,8 @@ * Contains Post entry content for Image mime-type Attachment * Pages * - * @uses function_name() + * @uses oenology_gallery_image_meta() Defined in /functions/custom.php + * @uses oenology_gallery_links() Defined in /functions/custom.php * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett @@ -128,88 +129,4 @@ - -post_parent); ?> -Displays the URL to the post parent of the current post. - -*********************** -get_the_title() ----------------------------------- -get_the_title() is a WordPress template tag. -Codex reference: http://codex.wordpress.org/Function_Reference/get_the_title - -get_the_title() is used to display the Post Title of the current post. - -get_the_title( $id ) accepts one argument: - - $id: ID of the post for which to return the Post Title - -Example: -post_parent); ?> -Displays the Post Title of the current post's parent post. - -*********************** -oenology_gallery_image_meta() ----------------------------------- -oenology_gallery_image_meta() is a custom Theme function. -Codex reference: N/A - -oenology_gallery_image_meta() is used to output various metadata related to -gallery images. oenology_gallery_image_meta() outputs an array containing the -following values: - - $image_meta['image']: image output, using wp_get_attachment_image() - - $image_meta['url']: image attachment url, using wp_get_attachment_url() - - $image_meta['width']: image width, in px - - $image_meta['height']: image height, in px - - $image_meta['dimensions']: image width/height dimensions, in px, displayed as "# x # px" - - $image_meta['filesize']: image filesize, converted to human-readable size format, displayed as e.g. "### kb" - - $image_meta['created_timestamp']: image metadata - date/time image taken, displayed as "D MMM YYYY" - - $image_meta['copyright']: image metadata - copyright statement - - $image_meta['credit']: image metadata - photographer - - $image_meta['aperture']: image metadata - camera aperture setting - - $image_meta['focal_length']: image metadata - camera focal length setting, displayed as "f/###" - - $image_meta['iso']: image metadata - camera ISO setting - - $image_meta['shutter_speed']: image metadata - camera shutter speed setting, displayed as e.g. "1/### sec" - - $image_meta['camera']: image metadata - camera type - - $image_meta['caption']: the image caption, as defined in image settings - -oenology_gallery_image_meta() is defined in functions.php. - -*********************** -oenology_gallery_links() ----------------------------------- -oenology_gallery_links() is a custom Theme function. -Codex reference: N/A - -oenology_gallery_links() is used to output "previous" and "next" links with both text and -thumbnail images, for use with gallery images. The function outputs an array containing the -following values: - - $links['prevlink']: text link to previous gallery image - - $links['prevthumb']: thumbnail of previous gallery image - - $links['nextlink']: text link to next gallery image - - $links['nextthumb']: thumbnail of next gallery image - -oenology_gallery_links() is defined in functions.php. - -============================================================================= -*/ ?> \ No newline at end of file + \ No newline at end of file diff --git a/post-entry.php b/post-entry.php index c890d20..b4c73cd 100644 --- a/post-entry.php +++ b/post-entry.php @@ -4,16 +4,17 @@ * * Contains Loop header, Loop content, and Loop footer. * - * @uses dynamic_sidebar() - * @uses get_template_part() - * @uses is_archive() - * @uses is_search() - * @uses the_content() - * @uses the_excerpt() - * @uses oenology_hook_post_entry_after() - * @uses oenology_hook_post_entry_before() - * @uses wp_attachment_is_image() - * @uses wp_link_pages() + * @uses oenology_hook_post_entry_after() Defined in /functions/hooks.php + * @uses oenology_hook_post_entry_before() Defined in /functions/hooks.php + * + * @link http://codex.wordpress.org/Function_Reference/dynamic_sidebar dynamic_sidebar() + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() + * @link http://codex.wordpress.org/Function_Reference/is_archive is_archive() + * @link http://codex.wordpress.org/Function_Reference/is_search is_search() + * @link http://codex.wordpress.org/Function_Reference/the_content the_content() + * @link http://codex.wordpress.org/Function_Reference/the_excerpt the_excerpt() + * @link http://codex.wordpress.org/Function_Reference/wp_attachment_is_image wp_attachment_is_image() + * @link http://codex.wordpress.org/Function_Reference/wp_link_pages wp_link_pages() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post-footer.php b/post-footer.php index 5d70800..2629fb4 100644 --- a/post-footer.php +++ b/post-footer.php @@ -4,11 +4,11 @@ * * Contains author avatar, footer metadata, and footer license * - * @uses oenology_hook_post_footer_after() - * @uses oenology_hook_post_footer_avatar() - * @uses oenology_hook_post_footer_before() - * @uses oenology_hook_post_footer_license() - * @uses oenology_hook_post_footer_metadata() + * @uses oenology_hook_post_footer_after() Defined in /functions/hooks.php + * @uses oenology_hook_post_footer_avatar() Defined in /functions/hooks.php + * @uses oenology_hook_post_footer_before() Defined in /functions/hooks.php + * @uses oenology_hook_post_footer_license() Defined in /functions/hooks.php + * @uses oenology_hook_post_footer_metadata() Defined in /functions/hooks.php * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post-gallery.php b/post-gallery.php index ed0e06a..7b9b1b8 100644 --- a/post-gallery.php +++ b/post-gallery.php @@ -5,7 +5,14 @@ * * This file is called by Posts with the "Gallery" Post Format * - * @uses get_template_part() + * @uses oenology_get_context() Defined in /functions/custom.php + * @uses oenology_hook_post_entry_after() Defined in /functions/hooks.php + * @uses oenology_hook_post_entry_before() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_metadata() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_taxonomies() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_title() Defined in /functions/hooks.php + * + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post-header.php b/post-header.php index c9ba267..33d230c 100644 --- a/post-header.php +++ b/post-header.php @@ -5,13 +5,13 @@ * Contains Post date, Post Thumbnail, Post Title, Post * Metadata, and Post Taxonomies (Categories and Tags) * - * @uses oenology_hook_post_header_after() - * @uses oenology_hook_post_header_before() - * @uses oenology_hook_post_header_date() - * @uses oenology_hook_post_header_thumbnail() - * @uses oenology_hook_post_header_title() - * @uses oenology_hook_post_header_metadata() - * @uses oenology_hook_post_header_taxonomies() + * @uses oenology_hook_post_header_after() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_before() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_date() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_thumbnail() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_title() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_metadata() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_taxonomies() Defined in /functions/hooks.php * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post-image.php b/post-image.php index 4c78e19..eda4202 100644 --- a/post-image.php +++ b/post-image.php @@ -5,7 +5,14 @@ * * This file is called by Posts with the "Image" Post Format * - * @uses get_template_part() + * @uses oenology_get_context() Defined in /functions/custom.php + * @uses oenology_hook_post_entry_after() Defined in /functions/hooks.php + * @uses oenology_hook_post_entry_before() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_metadata() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_taxonomies() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_title() Defined in /functions/hooks.php + * + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post-link.php b/post-link.php index 3b61ac6..8cb0eb2 100644 --- a/post-link.php +++ b/post-link.php @@ -5,7 +5,9 @@ * * This file is called by Posts with the "Link" Post Format * - * @uses get_template_part() + * @uses oenology_get_context() Defined in /functions/custom.php + * + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post-quote.php b/post-quote.php index 1cd6e7d..10e5f88 100644 --- a/post-quote.php +++ b/post-quote.php @@ -5,7 +5,9 @@ * * This file is called by Posts with the "Quote" Post Format * - * @uses get_template_part() + * @uses oenology_get_context() Defined in /functions/custom.php + * + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post-status.php b/post-status.php index 7bd2805..471814d 100644 --- a/post-status.php +++ b/post-status.php @@ -5,7 +5,9 @@ * * This file is called by Posts with the "Status" Post Format * - * @uses get_template_part() + * @uses oenology_get_context() Defined in /functions/custom.php + * + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post-video.php b/post-video.php index 90356c3..a81f7b2 100644 --- a/post-video.php +++ b/post-video.php @@ -5,7 +5,11 @@ * * This file is called by Posts with the "Video" Post Format * - * @uses get_template_part() + * @uses oenology_get_context() Defined in /functions/custom.php + * @uses oenology_hook_post_header_metadata() Defined in /functions/hooks.php + * @uses oenology_hook_post_header_taxonomies() Defined in /functions/hooks.php + * + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/post.php b/post.php index 44cec91..f727f55 100644 --- a/post.php +++ b/post.php @@ -5,8 +5,11 @@ * * This file is called by all primary template pages * - * @uses get_template_part() - * @uses is_front_page() + * @uses oenology_get_context() Defined in /functions/custom.php + * + * @link http://codex.wordpress.org/Function_Reference/get_option get_option() + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() + * @link http://codex.wordpress.org/Function_Reference/is_front_page is_front_page() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/sidebar-left.php b/sidebar-left.php index b4aca1f..2075a03 100644 --- a/sidebar-left.php +++ b/sidebar-left.php @@ -4,7 +4,9 @@ * * This file is called by all primary template pages * - * @uses the_widget() + * @uses oenology_get_widget_args() Defined in /functions/widgets.php + * + * @link http://codex.wordpress.org/Function_Reference/the_widget the_widget() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/sidebar-page.php b/sidebar-page.php index 84b7c00..cccdf10 100644 --- a/sidebar-page.php +++ b/sidebar-page.php @@ -4,11 +4,13 @@ * * This file is called by page.php * - * @uses dynamic_sidebar() - * @uses get_option() - * @uses get_sidebar() - * @uses is_attachment() - * @uses is_front_page() + * @uses oenology_get_current_page_layout() Defined in /functions/custom.php + * + * @link http://codex.wordpress.org/Function_Reference/dynamic_sidebar dynamic_sidebar() + * @link http://codex.wordpress.org/Function_Reference/get_option get_option() + * @link http://codex.wordpress.org/Function_Reference/get_sidebar get_sidebar() + * @link http://codex.wordpress.org/Function_Reference/is_attachment is_attachment() + * @link http://codex.wordpress.org/Function_Reference/is_front_page is_front_page() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/sidebar-right.php b/sidebar-right.php index be6e260..eb89375 100644 --- a/sidebar-right.php +++ b/sidebar-right.php @@ -4,7 +4,9 @@ * * This file is called by all primary template pages * - * @uses the_widget() + * @uses oenology_get_widget_args() Defined in /functions/widgets.php + * + * @link http://codex.wordpress.org/Function_Reference/the_widget the_widget() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/sidebar.php b/sidebar.php index 4009e35..fb7a943 100644 --- a/sidebar.php +++ b/sidebar.php @@ -4,15 +4,18 @@ * * This file is called by all primary template pages * - * @uses dynamic_sidebar() - * @uses get_bloginfo() - * @uses get_option() - * @uses get_sidebar() - * @uses has_post_format() - * @uses is_active_sidebar() - * @uses is_attachment() - * @uses is_front_page() - * @uses is_single() + * @uses oenology_get_current_page_layout() Defined in /functions/custom.php + * @uses oenology_get_social_networks() Defined in /functions/custom.php + * + * @link http://codex.wordpress.org/Function_Reference/dynamic_sidebar dynamic_sidebar() + * @link http://codex.wordpress.org/Function_Reference/get_bloginfo get_bloginfo() + * @link http://codex.wordpress.org/Function_Reference/get_option get_option() + * @link http://codex.wordpress.org/Function_Reference/get_sidebar get_sidebar() + * @link http://codex.wordpress.org/Function_Reference/has_post_format has_post_format() + * @link http://codex.wordpress.org/Function_Reference/is_active_sidebar is_active_sidebar() + * @link http://codex.wordpress.org/Function_Reference/is_attachment is_attachment() + * @link http://codex.wordpress.org/Function_Reference/is_front_page is_front_page() + * @link http://codex.wordpress.org/Function_Reference/is_single is_single() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett diff --git a/single.php b/single.php index e36b59f..c1f79c2 100644 --- a/single.php +++ b/single.php @@ -3,8 +3,8 @@ * Single Blog Post template file * * This file is the single blog post template file, used to display single blog posts. - * - * @uses oenology_get_context() + * + * @uses oenology_get_current_page_layout() Defined in /functions/custom.php * * @link http://codex.wordpress.org/Function_Reference/get_header get_header() * @link http://codex.wordpress.org/Function_Reference/get_footer get_footer() diff --git a/site-header.php b/site-header.php index 62c5fed..7476b3d 100644 --- a/site-header.php +++ b/site-header.php @@ -5,10 +5,12 @@ * * This file is called by all primary template pages * - * @uses get_template_part() - * @uses oenology_hook_site_header() - * @uses oenology_hook_site_header_after() - * @uses oenology_hook_site_header_before() + * @uses oenology_get_context() Defined in /functions/custom.php + * @uses oenology_hook_site_header() Defined in /functions/hooks.php + * @uses oenology_hook_site_header_after() Defined in /functions/hooks.php + * @uses oenology_hook_site_header_before() Defined in /functions/hooks.php + * + * @link http://codex.wordpress.org/Function_Reference/get_template_part get_template_part() * * @package Oenology * @copyright Copyright (c) 2010, Chip Bennett