Permalink
Browse files

Correct help and inline documentation.

  • Loading branch information...
1 parent 1513129 commit 7bba3d77ef09ac1d11128296efc9a198d2741a15 Michael Sisk committed Feb 12, 2013
Showing with 17 additions and 17 deletions.
  1. +2 −2 -/php/help.php
  2. +15 −15 -/php/tags.php
View
@@ -382,7 +382,7 @@ private function generator_overview() {
<p>%s</p>',
__( 'The Webcomic Generator can assist you in publishing a large backlog of webcomics. The right column lists all of the images in your Media Library that are not attached to a post. Select the files you would like to publish using the checkboxes, then adjust the publish settings on the left:', 'webcomic' ),
__( '<strong>Collection</strong> specifies the collection that all of the generated webcomics will belong to.', 'webcomic' ),
- __( '<strong>Start on&hellip;</strong> specifies the the date to begin publishing the selected images. The first selected image in the list will be published on this date.', 'webcomic' ),
+ __( '<strong>Start on&hellip;</strong> specifies the date to begin publishing the selected images. The first selected image in the list will be published on this date.', 'webcomic' ),
__( '<strong>Publish every&hellip;</strong> allows you to select which days of the week to publish subsequent files. The generator will work through the list from top to bottom, publishing selected files based on the days you select. You can reorder the images on the right by dragging and dropping the table rows to ensure they publish in the correct order.', 'webcomic' ),
__( '<strong>Save posts as drafts</strong> will cause all of the webcomics created by the generator to be drafted. These posts will not appear on your site until you publish them.', 'webcomic' ),
__( 'Webcomics created by the generator will use the image filename for the webcomic title.', 'webcomic' )
@@ -792,7 +792,7 @@ private function collection_settings_general() {
</ul>',
__( 'These settings allow you to change some of the basic information and features related to your collection:', 'webcomic' ),
__( '<strong>Name</strong> - The name is how it appears on your site.', 'webcomic' ),
- __( '<strong>Slug</strong> - The The "slug" is the URL-friendly version of the name. It is usually all lowercase and contains only letters, numbers, and hyphens.', 'webcomic' ),
+ __( '<strong>Slug</strong> - The "slug" is the URL-friendly version of the name. It is usually all lowercase and contains only letters, numbers, and hyphens.', 'webcomic' ),
__( '<strong>Description</strong> - The description is not prominent by default; it may be used in various ways, however.', 'webcomic' ),
__( '<strong>Poster</strong> - The poster is a representative image that can be displayed on your site.', 'webcomic' ),
__( '<strong>Theme</strong> - Determines what theme will be used when a user is viewing a page related to this collection.', 'webcomic' ),
View
@@ -1332,7 +1332,7 @@ public static function webcomic_term_image( $size = 'full', $term = 0, $taxonomy
* @return string
* @uses Webcomic::$config
* @uses WebcomicTag::get_relative_webcomic_link()
- * @filter get_webcomic_term_crossover_link
+ * @filter get_webcomic_term_crossover_link Filters the URL returned by get_webcomic_term_crossover_link.
*/
public static function get_webcomic_term_crossover_link( $collection = '', $term = 0, $taxonomy = '' ) {
global $wp_rewrite;
@@ -1538,7 +1538,7 @@ public static function webcomic_collection_print_amount( $type, $dec = '.', $sep
* @param string $before Before list.
* @param string $sep Separate items using this.
* @param string $after After list.
- * @param string $target Where the term links should point to, one of 'archive', 'first', 'last', or 'random'.
+ * @param string $target Where the collection links should point to, one of 'archive', 'first', 'last', or 'random'.
* @param string $image Image size to use when displaying crossover collections images for links.
* @param string $collection The collection to retrieve crossovers for.
* @return string
@@ -3371,7 +3371,7 @@ function is_webcomic_character( $character = '' ) {
* @package Webcomic
* @param string $collection Collection ID to check for.
* @return boolean
- * @uses WebcomicTag::$is_webcomic_crossover()
+ * @uses WebcomicTag::is_webcomic_crossover()
*/
function is_webcomic_crossover( $collection = '' ) {
return WebcomicTag::is_webcomic_crossover( $collection );
@@ -3460,27 +3460,27 @@ function has_webcomic_attachments( $the_post = false ) {
/** Is the current webcomic a crossover?
*
* <code class="php">
- * if ( is_webcomic_crossover() ) {
+ * if ( has_webcomic_crossover() ) {
* // this webcomic features characters or storylines from any other collection
* }
*
- * if ( is_webcomic_crossover( 'webcomic42' ) ) {
+ * if ( has_webcomic_crossover( 'webcomic42' ) ) {
* // this webcomic crosses over with storylines or characters from collection 42
* }
*
- * if ( is_webcomic_crossover( 'webcomic42_character' ) ) {
+ * if ( has_webcomic_crossover( 'webcomic42_character' ) ) {
* // this webcomic features one or more characters from collection 42
* }
*
- * if ( is_webcomic_crossover( '', 'ford-prefect' ) {
+ * if ( has_webcomic_crossover( '', 'ford-prefect' ) {
* // this webcomic crosses over with a storyline or character from any collection that has the slug ford-prefect
* }
*
- * if ( is_webcomic_crossover( 'character', 'ford-prefect' ) {
+ * if ( has_webcomic_crossover( 'character', 'ford-prefect' ) {
* // this webcomic features a character from any collection that has the slug ford-prefect
* }
*
- * if ( is_webcomic_crossover( 'webcomic42_sotyrline', 'mostly-harmless' ) {
+ * if ( has_webcomic_crossover( 'webcomic42_sotyrline', 'mostly-harmless' ) {
* // this webcomic crosses over with the storyline that has the slug mostly-harmless in collection 42
* }
* </code>
@@ -4085,7 +4085,7 @@ function purchase_webcomic_link( $format = '%link', $link = '', $the_post = fals
if ( !function_exists( 'the_webcomic_collection' ) ) {
/** Render a webcomic collection link.
*
- * @deprecated 4.0.7 4.1 Use the_webcomic_collections instead.
+ * @deprecated 4.0.7 4.1 the_webcomic_collections
*/
function the_webcomic_collection( $format = '%link', $link = '', $target = 'archive', $collection = '' ) {
echo WebcomicTag::webcomic_collection_link( $format, $link, $target, $collection );
@@ -4100,7 +4100,7 @@ function the_webcomic_collection( $format = '%link', $link = '', $target = 'arch
* the_webcomic_collections();
*
* // render an unordered list of collections related to the current webcomic
- * the_webcomic_collections( '<ul><li>', '</li><li>', </li></ul>' );
+ * the_webcomic_collections( '<ul><li>', '</li><li>', '</li></ul>' );
*
* // render links to the first webcomic in each collection related to the current webcomic with a small collection poster
* the_webcomic_collections( '<div><h2>collections</h2><figure>', '</figure><figure>', '</figure></div>', 'first', 'thumbnail' );
@@ -4933,10 +4933,10 @@ function webcomic_character_avatar( $size = 'full', $character = 0, $collection
* @param string $before Before list.
* @param string $sep Separate items using this.
* @param string $after After list.
- * @param string $target Where the term links should point to, one of 'archive', 'first', 'last', or 'random'.
+ * @param string $target Where the links should point to, one of 'archive', 'first', 'last', or 'random'.
* @param string $image Image size to use when displaying crossover collections images for links.
* @param integer $storyline Storyline ID to render a crossover list for.
- * @param mixed $taxonomy The collection the storyline belongs to.
+ * @param mixed $collection The collection the storyline belongs to.
* @uses WebcomicTag::webcomic_term_crossovers()
*/
function webcomic_storyline_crossovers( $before = '', $sep = ', ', $after = '', $target = 'archive', $image = '', $storyline = 0, $collection = '' ) {
@@ -4973,10 +4973,10 @@ function webcomic_storyline_crossovers( $before = '', $sep = ', ', $after = '',
* @param string $before Before list.
* @param string $sep Separate items using this.
* @param string $after After list.
- * @param string $target Where the term links should point to, one of 'archive', 'first', 'last', or 'random'.
+ * @param string $target Where the links should point to, one of 'archive', 'first', 'last', or 'random'.
* @param string $image Image size to use when displaying crossover collections images for links.
* @param integer $character character ID to render a crossover list for.
- * @param mixed $taxonomy The collection the character belongs to.
+ * @param mixed $collection The collection the character belongs to.
* @uses WebcomicTag::webcomic_term_crossovers()
*/
function webcomic_character_crossovers( $before = '', $sep = ', ', $after = '', $target = 'archive', $image = '', $character = 0, $collection = '' ) {

0 comments on commit 7bba3d7

Please sign in to comment.