From ca6ca3946718b8fcf2d9db464743031f6ff32f43 Mon Sep 17 00:00:00 2001
From: mark_story <mark@mark-story.com>
Date: Tue, 13 Oct 2009 12:09:06 -0400
Subject: [PATCH] Updating formatting on doc block for string insert.

---
 cake/libs/string.php | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/cake/libs/string.php b/cake/libs/string.php
index 67bed676815..fcfa76d9168 100644
--- a/cake/libs/string.php
+++ b/cake/libs/string.php
@@ -200,20 +200,21 @@ function tokenize($data, $separator = ',', $leftBound = '(', $rightBound = ')')
 /**
  * Replaces variable placeholders inside a $str with any given $data. Each key in the $data array
  * corresponds to a variable placeholder name in $str.
- * Example: String::insert(':name is :age years old.', array('name' => 'Bob', '65'));
+ * Example: `String::insert(':name is :age years old.', array('name' => 'Bob', '65'));`
  * Returns: Bob is 65 years old.
  *
  * Available $options are:
- * 	before: The character or string in front of the name of the variable placeholder (Defaults to ':')
- * 	after: The character or string after the name of the variable placeholder (Defaults to null)
- * 	escape: The character or string used to escape the before character / string (Defaults to '\')
- * 	format: A regex to use for matching variable placeholders. Default is: '/(?<!\\)\:%s/'
- *         (Overwrites before, after, breaks escape / clean)
- * 	clean: A boolean or array with instructions for String::cleanInsert
+ *
+ * - before: The character or string in front of the name of the variable placeholder (Defaults to `:`)
+ * - after: The character or string after the name of the variable placeholder (Defaults to null)
+ * - escape: The character or string used to escape the before character / string (Defaults to `\`)
+ * - format: A regex to use for matching variable placeholders. Default is: `/(?<!\\)\:%s/`
+ *   (Overwrites before, after, breaks escape / clean)
+ * - clean: A boolean or array with instructions for String::cleanInsert
  *
  * @param string $str A string containing variable placeholders
  * @param string $data A key => val array where each key stands for a placeholder variable name
- *        to be replaced with val
+ *     to be replaced with val
  * @param string $options An array of options, see description above
  * @return string
  * @access public