Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-09 02:17:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update vendor/docdown.

Browse Source 
Former-commit-id: 98cda48e4b63e2cd471c927ba36afbe2bb80938e
This commit is contained in:
John-David Dalton
2013-08-16 00:31:10 -07:00
parent 425499b3aa
commit 82c17dbde2
2 changed files with 23 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
vendor/docdown/docdown.php vendored
View File

@@ -4,7 +4,7 @@
* Copyright 2011-2013 John-David Dalton <http://allyoucanleet.com/> * Copyright 2011-2013 John-David Dalton <http://allyoucanleet.com/>
* Available under MIT license <http://mths.be/mit> * Available under MIT license <http://mths.be/mit>
*/ */
require(dirname(__FILE__) . '/src/DocDown/Generator.php'); require(dirname(__FILE__) . '/src/DocDown/MarkdownGenerator.php');
/** /**
* Generates Markdown from JSDoc entries in a given file. * Generates Markdown from JSDoc entries in a given file.
@@ -32,7 +32,7 @@ require(dirname(__FILE__) . '/src/DocDown/Generator.php');
* )); * ));
*/ */
function docdown( $options = array() ) { function docdown( $options = array() ) {
$gen = new Generator($options); $gen = new MarkdownGenerator($options);
return $gen->generate(); return $gen->generate();
} }
?> ?>

42
vendor/docdown/src/DocDown/Generator.php → vendor/docdown/src/DocDown/MarkdownGenerator.php vendored
View File

@@ -5,13 +5,13 @@ require(dirname(__FILE__) . "/Entry.php");
/** /**
* Generates Markdown from JSDoc entries. * Generates Markdown from JSDoc entries.
*/ */
class Generator { class MarkdownGenerator {
/** /**
* The HTML for the close tag. * The HTML for the close tag.
* *
* @static * @static
* @memberOf Generator * @memberOf MarkdownGenerator
* @type String * @type String
*/ */
public $closeTag = "\n<!-- /div -->\n"; public $closeTag = "\n<!-- /div -->\n";
@@ -19,7 +19,7 @@ class Generator {
/** /**
* An array of JSDoc entries. * An array of JSDoc entries.
* *
* @memberOf Generator * @memberOf MarkdownGenerator
* @type Array * @type Array
*/ */
public $entries = array(); public $entries = array();
@@ -28,7 +28,7 @@ class Generator {
* The HTML for the open tag. * The HTML for the open tag.
* *
* @static * @static
* @memberOf Generator * @memberOf MarkdownGenerator
* @type String * @type String
*/ */
public $openTag = "\n<!-- div -->\n"; public $openTag = "\n<!-- div -->\n";
@@ -36,7 +36,7 @@ class Generator {
/** /**
* An options array used to configure the generator. * An options array used to configure the generator.
* *
* @memberOf Generator * @memberOf MarkdownGenerator
* @type Array * @type Array
*/ */
public $options = array(); public $options = array();
@@ -44,7 +44,7 @@ class Generator {
/** /**
* The file's source code. * The file's source code.
* *
* @memberOf Generator * @memberOf MarkdownGenerator
* @type String * @type String
*/ */
public $source = ''; public $source = '';
@@ -52,7 +52,7 @@ class Generator {
/*--------------------------------------------------------------------------*/ /*--------------------------------------------------------------------------*/
/** /**
* The Generator constructor. * The MarkdownGenerator constructor.
* *
* @constructor * @constructor
* @param {String} $source The source code to parse. * @param {String} $source The source code to parse.
@@ -103,7 +103,7 @@ class Generator {
* *
* @private * @private
* @static * @static
* @memberOf Generator * @memberOf MarkdownGenerator
* @param {String} $string The string to format. * @param {String} $string The string to format.
* @returns {String} The formatted string. * @returns {String} The formatted string.
*/ */
@@ -137,7 +137,7 @@ class Generator {
* *
* @private * @private
* @static * @static
* @memberOf Generator * @memberOf MarkdownGenerator
* @param {String} $string The string to modify. * @param {String} $string The string to modify.
* @param {Array|Object} $object The template object. * @param {Array|Object} $object The template object.
* @returns {String} The modified string. * @returns {String} The modified string.
@@ -165,7 +165,7 @@ class Generator {
} }
$string = preg_replace($pattern, trim($replacement), $string); $string = preg_replace($pattern, trim($replacement), $string);
} }
return Generator::format($string); return MarkdownGenerator::format($string);
} }
/*--------------------------------------------------------------------------*/ /*--------------------------------------------------------------------------*/
@@ -174,7 +174,7 @@ class Generator {
* Adds the given `$entries` to the `$result` array. * Adds the given `$entries` to the `$result` array.
* *
* @private * @private
* @memberOf Generator * @memberOf MarkdownGenerator
* @param {Array} $result The result array to modify. * @param {Array} $result The result array to modify.
* @param {Array} $entries The entries to add to the `$result`. * @param {Array} $entries The entries to add to the `$result`.
*/ */
@@ -188,7 +188,7 @@ class Generator {
array_push( array_push(
$result, $result,
$this->openTag, $this->openTag,
Generator::interpolate("### <a id=\"#{hash}\"></a>`#{member}#{separator}#{call}`\n<a href=\"##{hash}\">#</a> [&#x24C8;](#{href} \"View in source\") [&#x24C9;][1]\n\n#{desc}", $entry) MarkdownGenerator::interpolate("### <a id=\"#{hash}\"></a>`#{member}#{separator}#{call}`\n<a href=\"##{hash}\">#</a> [&#x24C8;](#{href} \"View in source\") [&#x24C9;][1]\n\n#{desc}", $entry)
); );
// @alias // @alias
@@ -203,7 +203,7 @@ class Generator {
if (count($params = $entry->getParams())) { if (count($params = $entry->getParams())) {
array_push($result, '', '#### Arguments'); array_push($result, '', '#### Arguments');
foreach ($params as $index => $param) { foreach ($params as $index => $param) {
$result[] = Generator::interpolate('#{num}. `#{name}` (#{type}): #{desc}', array( $result[] = MarkdownGenerator::interpolate('#{num}. `#{name}` (#{type}): #{desc}', array(
'desc' => $param[2], 'desc' => $param[2],
'name' => $param[1], 'name' => $param[1],
'num' => $index + 1, 'num' => $index + 1,
@@ -216,7 +216,7 @@ class Generator {
array_push( array_push(
$result, '', $result, '',
'#### Returns', '#### Returns',
Generator::interpolate('(#{type}): #{desc}', array('desc' => $returns[1], 'type' => $returns[0])) MarkdownGenerator::interpolate('(#{type}): #{desc}', array('desc' => $returns[1], 'type' => $returns[0]))
); );
} }
// @example // @example
@@ -231,7 +231,7 @@ class Generator {
* Resolves the entry's hash used to navigate the documentation. * Resolves the entry's hash used to navigate the documentation.
* *
* @private * @private
* @memberOf Generator * @memberOf MarkdownGenerator
* @param {Number|Object} $entry The entry object. * @param {Number|Object} $entry The entry object.
* @param {String} $member The name of the member. * @param {String} $member The name of the member.
* @returns {String} The url hash. * @returns {String} The url hash.
@@ -250,7 +250,7 @@ class Generator {
* Resolves the entry's url for the specific line number. * Resolves the entry's url for the specific line number.
* *
* @private * @private
* @memberOf Generator * @memberOf MarkdownGenerator
* @param {Number|Object} $entry The entry object. * @param {Number|Object} $entry The entry object.
* @returns {String} The url. * @returns {String} The url.
*/ */
@@ -263,7 +263,7 @@ class Generator {
* Extracts the character used to separate the entry's name from its member. * Extracts the character used to separate the entry's name from its member.
* *
* @private * @private
* @memberOf Generator * @memberOf MarkdownGenerator
* @param {Number|Object} $entry The entry object. * @param {Number|Object} $entry The entry object.
* @returns {String} The separator. * @returns {String} The separator.
*/ */
@@ -277,7 +277,7 @@ class Generator {
/** /**
* Generates Markdown from JSDoc entries. * Generates Markdown from JSDoc entries.
* *
* @memberOf Generator * @memberOf MarkdownGenerator
* @returns {String} The rendered Markdown. * @returns {String} The rendered Markdown.
*/ */
public function generate() { public function generate() {
@@ -453,7 +453,7 @@ class Generator {
); );
// add entries // add entries
foreach ($entries as $entry) { foreach ($entries as $entry) {
$result[] = Generator::interpolate('* [`#{member}#{separator}#{name}`](##{hash})', $entry); $result[] = MarkdownGenerator::interpolate('* [`#{member}#{separator}#{name}`](##{hash})', $entry);
} }
} }
} }
@@ -475,7 +475,7 @@ class Generator {
array_push( array_push(
$result, $result,
$openTag, '## ' . (count($result) == 2 ? '<a id="' . $toc . '"></a>' : '') . '`' . $member . '`', $openTag, '## ' . (count($result) == 2 ? '<a id="' . $toc . '"></a>' : '') . '`' . $member . '`',
Generator::interpolate('* [`' . $member . '`](##{hash})', $entry) MarkdownGenerator::interpolate('* [`' . $member . '`](##{hash})', $entry)
); );
// add static and plugin sub-entries // add static and plugin sub-entries
@@ -490,7 +490,7 @@ class Generator {
} }
foreach ($entry->{$kind} as $subentry) { foreach ($entry->{$kind} as $subentry) {
$subentry->member = $member; $subentry->member = $member;
$result[] = Generator::interpolate('* [`#{member}#{separator}#{name}`](##{hash})', $subentry); $result[] = MarkdownGenerator::interpolate('* [`#{member}#{separator}#{name}`](##{hash})', $subentry);
} }
} }
} }