8
0

Add documentation in some places

Dieser Commit ist enthalten in:
Stéphane Goetz 2017-06-07 23:40:12 +02:00
Ursprung 762d482a80
Commit 5a24c48788
6 geänderte Dateien mit 27 neuen und 3 gelöschten Zeilen

Datei anzeigen

@ -98,6 +98,13 @@ class Daux
}
}
/**
* Get the file requested for configuration overrides
*
* @param string|null $override_file
* @return string|null the path to a file to load for configuration overrides
* @throws Exception
*/
public function getConfigurationOverride($override_file)
{
// When running through `daux --serve` we set an environment variable to know where we started from

Datei anzeigen

@ -43,6 +43,13 @@ class ContentPage extends \Todaymade\Daux\Format\Base\ContentPage
return $intro . $content;
}
/**
* Create an image tag for the specified filename
*
* @param string $filename
* @param array $attributes
* @return string
*/
private function createImageTag($filename, $attributes)
{
$img = '<ac:image';

Datei anzeigen

@ -1,7 +1,7 @@
<?php namespace Todaymade\Daux\Format\Confluence\ContentTypes\Markdown;
use League\CommonMark\HtmlElement;
use League\CommonMark\ElementRendererInterface;
use League\CommonMark\HtmlElement;
use League\CommonMark\Inline\Element\AbstractInline;
use League\CommonMark\Inline\Element\Link;

Datei anzeigen

@ -14,7 +14,6 @@ use League\CommonMark\Node\Node;
use ReflectionMethod;
use Todaymade\Daux\Config;
use Todaymade\Daux\ContentTypes\Markdown\TableOfContents;
use Todaymade\Daux\DauxHelper;
class Processor implements DocumentProcessorInterface
{
@ -73,6 +72,11 @@ class Processor implements DocumentProcessorInterface
}
}
/**
* Get an escaped version of the link
* @param string $url
* @return string
*/
protected function escaped($url) {
$url = trim($url);
$url = preg_replace('~[^\\pL0-9_]+~u', '-', $url);

Datei anzeigen

@ -137,6 +137,7 @@ class Server
/**
* Handle a request on custom themes
*
* @param string $request
* @return \Todaymade\Daux\Format\Base\Page
* @throws NotFoundException
*/

Datei anzeigen

@ -22,7 +22,6 @@ class Content extends ContentAbstract
protected function getFrontMatter()
{
$content = null;
if ($this->manuallySetContent) {
$content = $this->content;
} else if (!$this->getPath()) {
@ -123,6 +122,12 @@ class Content extends ContentAbstract
$this->attributes = $attributes;
}
/**
* Get one or all attributes for the content
*
* @param string|null $key
* @return array|mixed|null
*/
public function getAttribute($key = null)
{
if ($this->attributes === null) {