Skip to content

No markdown except in template "clean" #1064

Open
fi5er opened this Issue Oct 16, 2013 · 2 comments

2 participants

@fi5er
fi5er commented Oct 16, 2013

Using the phar file (version 2.1.0), markdown formatting seems to be ignored everywhere, except in the "clean" template.

I could use the "clean" template, but there are other issues with it:

  • it seems to rely on Ajax, even for local files
  • there is no file list

The lack of a file list is a problem for us, because without it, we cannot document stand-alone scripts (like build scripts, init scripts, config files, etc). Scripts like that usually only have the file-level doc block and maybe some constants or functions. Apparently a script must contain a class, or the file-level doc block won't be accessible with the "clean" template.

Other templates (like "zend" or "new-black") do have file lists, but no markdown, in addition to other errors which are probably already known.

@fi5er
fi5er commented Oct 16, 2013

This is the test file I experimented with:

<?php
/**
 * This is the *short* file description.
 *
 * This is the long file description.
 *
 *     $a->code($block)
 *
 * ### A headline
 *
 * - A list item
 * - Another
 *
 * @license  http://www.opensource.org/licenses/mit-license.php MIT License
 */

namespace TestNS;

/**
 * a documented *function*
 *
 * - list item 1
 * - list item 2
 *
 * @return string
 */
function test () {}

I create the documentation with php /path/phpDocumentor.phar -f TestDoc.php -t out --template X.

Example output from the "new-black" template:
This is the long file description. $a->code($block) ### A headline - A list item - Another

@mvriel
phpDocumentor member
mvriel commented Nov 23, 2013

We are in the process of updating the other templates to bring them up to speed as well; because XSL works different from twig this takes additional effort.

@siad007 siad007 added a commit to siad007/phpDocumentor2 that referenced this issue Dec 3, 2013
@siad007 siad007 Add markdown in long-description for xml-based templates
Fixes #1064
012ba1f
@mvriel mvriel modified the milestone: 2.4, 2.3 Feb 16, 2014
@mvriel mvriel modified the milestone: 2.5, 2.4 Mar 30, 2014
@mvriel mvriel modified the milestone: 2.6, 2.5, 2.7 May 17, 2014
@siad007 siad007 added a commit to siad007/template.abstract that referenced this issue Jun 1, 2014
@siad007 siad007 Added markdown to long-description 71d381e
@mvriel mvriel added the Template label Jul 9, 2014
@mvriel mvriel modified the milestone: 2.7, 2.8 Aug 30, 2014
@mvriel mvriel modified the milestone: 2.8 Feb 18, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.