From 339935b2f5a52dbd42c93a04f5c1630d03001855 Mon Sep 17 00:00:00 2001 From: David Persson Date: Tue, 1 Jul 2014 20:27:37 +0200 Subject: [PATCH] Use ticks instead of curly braces. --- README.md | 21 +++++++++++++++------ extensions/docs/Extractor.php | 4 ++-- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 64fd253..fb68e90 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# li3 docs + Li3_docs is a **Lithium plugin**, NOT a Lithium app. Furthermore, by itself it is a VIEWER ONLY and contains no actual documentation other than its own. Once installed in your existing application, however, it generates documentation from your app's docblocks in real-time, which is all accessible from http://yourapp.tld/docs/. Not only that, but it will generate documentation for your plugins, too. Including itself; so it is self-replicating in a way. In this vein, it becomes part of a series of plugins required in order to obtain various documentation volumes of interest. @@ -14,6 +16,7 @@ So the Lithium documentation plugin (Li3 Docs) is a tool for creating automatica For generating documentation, Li3 Docs relies on PHP documentation blocks, or _docblocks_. These docblocks can appear above classes, methods, properties, etc., and contain three things: a short description, a longer description (often including usage examples), and docblock _tags_, which are denoted by an `@` symbol, followed by a keyword. A typical docblock might look something like this: +``` /** * Contains an instance of the `Request` object with all the details of the HTTP request that * was dispatched to the controller object. Any parameters captured in routing, such as @@ -24,6 +27,7 @@ For generating documentation, Li3 Docs relies on PHP documentation blocks, or _d * @var object */ public $request = null; +``` This docblock documents a class property, and contains a short description and two docblock tags. The tags to be used in a docblock vary by what is being documented. A property docblock should contain a `@var` tag that describes what type of value the property holds, while methods have a series of `@param` tags and a `@return` tag. @@ -31,13 +35,13 @@ There are also general tags which can be added to any docblock. These include th ### Markdown syntax -Docblock descriptions are written in Markdown format, with a few conventions. Namely, any code references or identifiers should be enclosed in backticks. This includes namespaces, classes, variable names, and keywords like `true`, `false` and `null`. Extended code examples should be written enclosed in three sets of curly braces, i.e.: {‍{{ // Code goes here }}}. +Docblock descriptions are written in Markdown format, with a few conventions. Namely, any code references or identifiers should be enclosed in backticks. This includes namespaces, classes, variable names, and keywords like `true`, `false` and `null`. Extended code examples should be written enclosed in three sets of backticks, i.e.: ``‍`` // Code goes here ```. ### Code embedding In order to improve the testability of documented code examples, and to help ensure that code and documentation stay in sync, Li3 Docs supports a special syntax that allows code from class methods to be embedded inline inside Markdown text. Consider the following: - {{{ embed:lithium\tests\cases\core\EnvironmentTest::testSetAndGetCurrentEnvironment(1-3) }‍}} + ``` embed:lithium\tests\cases\core\EnvironmentTest::testSetAndGetCurrentEnvironment(1-3) `‍`` This will embed code from the `testSetAndGetCurrentEnvironment()` method of the `Environment` test case, from line 1 through line 3 as an inline code example in the Markdown text. This way, whenever the code changes, the tests change to match it, and the documentation stays up-to-date with what's in the test. @@ -46,22 +50,25 @@ Finally, since explanations and descriptions of code can fall out of sync with e ### Browsing Once loaded into your application the plugin will enable browsing for all added libraries. In some cases it may be desired to disable browsing for certain libraries. In order to do so pass the `'index'` option in the second parameter when adding Li3 Docs: - +``` Libraries::add('li3_docs', array( 'index' => array('lithium', 'li3_bot') )); +``` By default, the url to view the docs is `'/docs'`. This can be customized with the `'url'` option in the second paramter when adding Li3 Docs: - +``` Libraries::add('li3_docs', array( 'url' => '/documentation' )); +``` Or if you wanted to have an app who's sole purpose is displaying docs, you could add all of your libraries and plugins to that app with `'bootstrap' => false` in the second parameter when adding the libraries with `Libraries::add()`. Then point the Li3 Docs url to the root of the app: - +``` Libraries::add('li3_docs', array( 'url' => '/' )); +``` ### Searching @@ -74,4 +81,6 @@ The plugin now features a symbol-based live search. Search for classes, methods To update the search database, run the symbol harvesting task: - $ li3 harvest +``` +$ li3 harvest +``` diff --git a/extensions/docs/Extractor.php b/extensions/docs/Extractor.php index 33b6581..2f02dbd 100644 --- a/extensions/docs/Extractor.php +++ b/extensions/docs/Extractor.php @@ -257,7 +257,7 @@ protected static function _codeToDoc($code) { $current = ''; } if ($current) { - $display[] = "{{{\n{$current}}}}"; + $display[] = "```\n{$current}```"; $current = ''; } $doc = Docblock::comment($token[1]); @@ -271,7 +271,7 @@ protected static function _codeToDoc($code) { $current .= (is_array($token) ? $token[1] : $token); } if ($current) { - $display[] = "{{{\n{$current}}}}"; + $display[] = "```\n{$current}```"; } return $display; }