Permalink
Browse files

Documentation updates galore.

git-svn-id: http://svn.locallylost.com/themes/hybrid-core/trunk@397 dba0f204-706d-4bc1-bc29-8b92e0485636
  • Loading branch information...
1 parent c3cf33f commit 3594f29e481faa4ab8b85fb3a070d335ca888922 greenshady committed Oct 15, 2010
View
@@ -14,7 +14,7 @@
/**
* Initializes any admin-related features needed for the framework.
*
- * @since 0.7
+ * @since 0.7.0
*/
function hybrid_admin_init() {
@@ -56,7 +56,7 @@ function hybrid_admin_enqueue_style() {
* Function for getting an array of available custom templates with a specific header. Ideally,
* this function would be used to grab custom singular post (any post type) templates.
*
- * @since 0.7
+ * @since 0.7.0
* @param array $args Arguments to check the templates against.
* @return array $post_templates The array of templates.
*/
View
@@ -17,7 +17,7 @@
* function for grabbing a list of available post types and adding a new meta box for
* each post type.
*
- * @since 0.7
+ * @since 0.7.0
* @uses get_post_types() Gets an array of post type objects.
* @uses add_meta_box() Adds a meta box to the post editing screen.
*/
@@ -48,7 +48,7 @@ function hybrid_create_post_meta_box() {
* Creates the settings for the post meta box depending on some things in how the theme is
* set up.
*
- * @since 0.7
+ * @since 0.7.0
* @param string $type The post_type of the current post in the post editor.
*/
function hybrid_post_meta_box_args( $type = '' ) {
@@ -107,7 +107,7 @@ function hybrid_post_meta_box_args( $type = '' ) {
* from the hybrid_post_meta_box_args() function. It then loops through each item in the array and
* displays a form element based on the type of setting it should be.
*
- * @since 0.7
+ * @since 0.7.0
* @parameter object $object Post object that holds all the post information.
* @parameter array $box The particular meta box being shown and its information.
*/
@@ -132,7 +132,7 @@ function hybrid_post_meta_box( $object, $box ) {
/**
* Outputs a text input box with the given arguments for use with the post meta box.
*
- * @since 0.7
+ * @since 0.7.0
* @param array $args
* @param string|bool $value Custom field value.
*/
@@ -148,7 +148,7 @@ function hybrid_post_meta_box_text( $args = array(), $value = false ) {
/**
* Outputs a select box with the given arguments for use with the post meta box.
*
- * @since 0.7
+ * @since 0.7.0
* @param array $args
* @param string|bool $value Custom field value.
*/
@@ -171,7 +171,7 @@ function hybrid_post_meta_box_select( $args = array(), $value = false ) {
/**
* Outputs a textarea with the given arguments for use with the post meta box.
*
- * @since 0.7
+ * @since 0.7.0
* @param array $args
* @param string|bool $value Custom field value.
*/
@@ -187,7 +187,7 @@ function hybrid_post_meta_box_textarea( $args = array(), $value = false ) {
/**
* Outputs radio inputs with the given arguments for use with the post meta box.
*
- * @since 0.8
+ * @since 0.8.0
* @param array $args
* @param string|bool $value Custom field value.
*/
@@ -208,7 +208,7 @@ function hybrid_post_meta_box_radio( $args = array(), $value = false ) {
* The function for saving the theme's post meta box settings. It loops through each of the meta
* box arguments for that particular post type and adds, updates, or deletes the metadata.
*
- * @since 0.7
+ * @since 0.7.0
* @param int $post_id
*/
function hybrid_save_post_meta_box( $post_id, $post ) {
View
@@ -23,7 +23,7 @@
* Users or developers can set a custom capability (default is 'edit_themes') for access to the
* settings page using the "$prefix_settings_capability" filter hook.
*
- * @since 0.7
+ * @since 0.7.0
* @global string $hybrid The global theme object.
*/
function hybrid_settings_page_init() {
@@ -57,7 +57,7 @@ function hybrid_settings_page_init() {
* developers should validate/sanitize their theme settings on the "sanitize_option_{$prefix}_theme_settings"
* hook. This function merely exists for backwards compatibility.
*
- * @since 0.7
+ * @since 0.7.0
*/
function hybrid_save_theme_settings( $settings ) {
$prefix = hybrid_get_prefix();
@@ -108,7 +108,7 @@ function hybrid_get_default_theme_settings() {
* {$prefix}_theme_settings in the database. It also fires the {$prefix}_update_settings_page
* hook for saving custom settings.
*
- * @since 0.7
+ * @since 0.7.0
*/
function hybrid_load_settings_page() {
$prefix = hybrid_get_prefix();
@@ -131,7 +131,7 @@ function hybrid_load_settings_page() {
* Creates the default meta boxes for the theme settings page. Child theme and plugin developers
* should use add_meta_box() to create additional meta boxes.
*
- * @since 0.7
+ * @since 0.7.0
* @global string $hybrid The global theme object.
*/
function hybrid_create_settings_meta_boxes() {
@@ -161,7 +161,7 @@ function hybrid_create_settings_meta_boxes() {
* information about both the parent theme and child theme. If a child theme is active, this function
* will be called a second time.
*
- * @since 0.7
+ * @since 0.7.0
* @param $object Variable passed through the do_meta_boxes() call.
* @param array $box Specific information about the meta box being loaded.
*/
@@ -198,7 +198,7 @@ function hybrid_about_theme_meta_box( $object, $box ) {
* Creates a settings box that allows users to customize their footer. A basic textarea is given that
* allows HTML and shortcodes to be input.
*
- * @since 0.7
+ * @since 0.7.0
*/
function hybrid_footer_settings_meta_box() {
$domain = hybrid_get_textdomain(); ?>
@@ -223,7 +223,7 @@ function hybrid_footer_settings_meta_box() {
* Displays the theme settings page and calls do_meta_boxes() to allow additional settings
* meta boxes to be added to the page.
*
- * @since 0.7
+ * @since 0.7.0
* @global string $hybrid The global theme object.
*/
function hybrid_settings_page() {
@@ -271,7 +271,7 @@ function hybrid_settings_page() {
* Loads the JavaScript files required for managing the meta boxes on the theme settings
* page, which allows users to arrange the boxes to their liking.
*
- * @since 0.7
+ * @since 0.7.0
*/
function hybrid_settings_page_enqueue_script() {
wp_enqueue_script( 'common' );
@@ -282,7 +282,7 @@ function hybrid_settings_page_enqueue_script() {
/**
* Loads the JavaScript required for toggling the meta boxes on the theme settings page.
*
- * @since 0.7
+ * @since 0.7.0
* @global string $hybrid The global theme object.
*/
function hybrid_settings_page_load_scripts() {
View
@@ -4,13 +4,13 @@
* precise control over their display and makes more filter and action hooks available to developers
* to use in their customizations.
*
- * @package Hybrid
+ * @package HybridCore
* @subpackage Functions
*/
/**
* Filter the comment form defaults.
- * @since 0.8
+ * @since 0.8.0
*/
add_filter( 'comment_form_defaults', 'hybrid_comment_form_args' );
@@ -20,7 +20,7 @@
* $style should remain 'ol' since this is hardcoded into the theme and is the semantically correct
* element to use for listing comments.
*
- * @since 0.7
+ * @since 0.7.0
* @return array $args Arguments for listing comments.
*/
function hybrid_list_comments_args() {
@@ -80,7 +80,7 @@ function hybrid_comments_end_callback() {
* available. Adds a call to HYBRID_IMAGES . "/{$comment_type}.png" for the default avatars for
* trackbacks and pingbacks.
*
- * @since 0.2
+ * @since 0.2.0
* @global $comment The current comment's DB object.
* @global $hybrid The global Hybrid object.
*/
@@ -114,7 +114,7 @@ function hybrid_avatar() {
/**
* Function for displaying a comment's metadata.
*
- * @since 0.7
+ * @since 0.7.0
* @param string $metadata Custom metadata to use.
* @global $comment The global comment object.
* @global $post The global post object.
@@ -135,7 +135,7 @@ function hybrid_comment_meta( $metadata = '' ) {
* the theme to preserve some backwards compatibility with its old comment form. It also allows
* users to build custom comment forms by filtering 'comment_form_defaults' in their child theme.
*
- * @since 0.8
+ * @since 0.8.0
* @param array $args The default comment form arguments.
* @return array $args The filtered comment form arguments.
*/
View
@@ -21,7 +21,7 @@
* based archives depending on several factors. For example, one could load an archive for a specific
* second during a specific minute within a specific hour on a specific day and so on.
*
- * @since 0.7
+ * @since 0.7.0
* @global $wp_query The current page's query object.
* @global $hybrid The global Hybrid object.
* @return array $hybrid->context Several contexts based on the current page.
@@ -116,7 +116,7 @@ function hybrid_get_context() {
* 'hentry'. Posts are given category, tag, and author classes. Alternate post classes of odd,
* even, and alt are added.
*
- * @since 0.5
+ * @since 0.5.0
* @global $post The current post's DB object.
* @param string|array $class Additional classes for more control.
* @return string $class
@@ -188,7 +188,7 @@ function hybrid_entry_class( $class = '', $post_id = null ) {
* and reader classes. Needs more work because WP, by default, assigns even/odd backwards
* (Odd should come first, even second).
*
- * @since 0.2
+ * @since 0.2.0
* @global $wpdb WordPress DB access object.
* @global $comment The current comment's DB object.
*/
@@ -237,7 +237,7 @@ function hybrid_comment_class( $class = '' ) {
/**
* Provides classes for the <body> element depending on page context.
*
- * @since 0.1
+ * @since 0.1.0
* @uses $wp_query
* @param string|array $class Additional classes for more control.
* @return string
@@ -303,7 +303,7 @@ function hybrid_body_class( $class = '' ) {
* Function for handling what the browser/search engine title should be. Tries to handle every
* situation to make for the best SEO.
*
- * @since 0.1
+ * @since 0.1.0
* @global $wp_query
*/
function hybrid_document_title() {
View
@@ -1,11 +1,14 @@
<?php
/**
- * Temporary file to hold SEO/<head> stuff until a permanent home is found.
+ * SEO and header functions. Not all things in this file are strictly for search engine optimization. Many
+ * of the functions handle basic <meta> elements for the <head> area of the site. This file is a catchall file
+ * for adding these types of things to themes.
*
* @package HybridCore
* @subpackage Functions
*/
+/* Add <meta> elements to the <head> area. */
add_action( 'wp_head', 'hybrid_meta_robots', 1 );
add_action( 'wp_head', 'hybrid_meta_author', 1 );
add_action( 'wp_head', 'hybrid_meta_copyright', 1 );
@@ -14,8 +17,8 @@
add_action( 'wp_head', 'hybrid_meta_keywords', 1 );
/**
- * Sets the default meta robots setting. If private, don't send meta info to the
- * header. Runs the hybrid_meta_robots filter hook at the end.
+ * Sets the default meta robots setting. If private, don't send meta info to the header. Runs the
+ * hybrid_meta_robots filter hook at the end.
*
* @since 0.2.3
*/
@@ -28,8 +31,8 @@ function hybrid_meta_robots() {
}
/**
- * Generates the meta author. On single posts and pages, use the author's name.
- * On the home page, use all authors. The hybrid_meta_author filter added in 0.6.
+ * Generates the meta author. On single posts and pages, use the author's name. On the home page, use
+ * all authors. The hybrid_meta_author filter added in 0.6.
*
* @since 0.3.3
*/
@@ -48,11 +51,10 @@ function hybrid_meta_author() {
}
/**
- * Add the meta tag for copyright information to the header. Single
- * posts and pages should display the date written. All other pages will
- * show the current year. The hybrid_meta_copyright filter added in 0.6.
+ * Add the meta tag for copyright information to the header. Single posts and pages should display the
+ * date written. All other pages will show the current year.
*
- * @since 0.4
+ * @since 0.4.0
*/
function hybrid_meta_copyright() {
$domain = hybrid_get_textdomain();
@@ -67,11 +69,10 @@ function hybrid_meta_copyright() {
}
/**
- * Add the revised meta tag on single posts and pages. This shows the
- * last time the post/page was modified. The hybrid_meta_revised filter
- * added in 0.6.
+ * Add the revised meta tag on single posts and pages (or any post type). This shows the last time the post
+ * was modified.
*
- * @since 0.4
+ * @since 0.4.0
*/
function hybrid_meta_revised() {
$revised = '';
@@ -83,8 +84,8 @@ function hybrid_meta_revised() {
}
/**
- * Generates the meta description. Checks theme settings for indexing, title,
- * and meta settings. Customize this with the hybrid_meta_description filter.
+ * Generates the meta description. Checks theme settings for indexing, title, and meta settings. Customize
+ * this with the hybrid_meta_description filter.
*
* @since 0.2.3
*/
@@ -129,8 +130,7 @@ function hybrid_meta_description() {
}
/**
- * Generates meta keywords/tags for the site. Checks theme settings.
- * Checks indexing settings. Customize with the hybrid_meta_keywords filter.
+ * Generates meta keywords/tags for the site.
*
* @since 0.2.3
*/
Oops, something went wrong.

0 comments on commit 3594f29

Please sign in to comment.