DocBlox

PHP 5.3 compatible API Documentation generator aimed at projects of all sizes and Continuous Integration

Release of v0.18.1

Posted on | January 10, 2012 | 12 Comments

Wow, only 2 days since 0.18.0 and already a new release? A whole lot of feedback came in, 2 new small features got in and a blocking issue was discovered and fixed.

Here is the rundown of what has changed:

  • Fixed an incompatibility with PHP 5.2.x
  • Parse errors had the wrong line number
  • Added an error code entry to the line numbers
  • Added a new variable UNPREFIXED_CLASS to the External Class Documentation feature to do a URL substitution with the unprefixed class name.
  • Altered the order of precedence for the external class documentation feature
  • Parsing could break on certain special characters in descriptions
  • Incremental processing broke due to a node import error

Some of these were old, some new but they had it be fixed fast.

Thanks for all the feedback and keep it coming!

Comments

12 Responses to “Release of v0.18.1”

  1. Thorsten Suckow-Homberg
    January 12th, 2012 @ 12:35 pm

    Thanks, works like a charm :)

  2. Shocker
    January 13th, 2012 @ 2:44 pm

    Downloaded v0.18.1, but the folder data/templates/new_black/ is empty, which resulted in this error:

    PHP Warning: file_get_contents(C:\lib\docblox_v0.18.1\data\templates\new_black\
    template.xml): failed to open stream: No such file or directory in C:\lib\docblo
    x_v0.18.1\src\DocBlox\Transformer.php on line 283

    I installed the zend Template, which has its contents in data/templates/zend/, but when running Docblox with “–template zend”, it throws this weird error:

    ERROR: The source path does not exist: C:\lib\docblox_v0.18.1\src\DocBlox\Transf
    ormer\..\..\..\data\templates/new_black/css

    Docblox is quite unusable like that.. :/

  3. mvriel
    January 13th, 2012 @ 2:55 pm

    The new_black template is the basic template from which all others are derived; this makes it easier for template builders to create their own branding without having to do the nitty gritty work.

    I just noticed that this detail is missing from the docs on manual installation; i will fix that as soon as possible.
    For now: if you run the command `./bin/docblox.php template:install new_black 1.0.1` then the template will be installed for you.

  4. John
    January 17th, 2012 @ 9:33 pm

    Not sure when this started, but I notice that a file-level @package tag isn’t being inherited by global functions in DocBlox 0.18.1.

    The documentation indicates that it should be inherited, but global functions with a file-level package tag are appearing in the “Default” package.

  5. mvriel
    January 18th, 2012 @ 5:02 am

    Hi John, thanks for mentioning this!
    I have created issue #356 to investigate this issue

  6. gggeek
    January 23rd, 2012 @ 1:03 pm

    About installing the theme: if Docblox is not installed via pear, the command syntax is slightly different:
    `./bin/docblox.php template:install new_black -v 1.0.1`

  7. SimonC
    January 31st, 2012 @ 2:09 pm

    Just wanted to say ‘Thank you’ for writing DocBlox.

    We have started using DocBlox in our Jenkins builds – mainly because of the performance vs phpDoc. (docblox runs over our code in three minutes; phpDoc crashed after thrashing for over 45 mins).

    I think the DocBlox templates could use a bit of work; the finished documentation is harder to navigate and read than the docs from other tools, but I’m sure that will improve over time.

    Finally, a bug report: some @todo items are being shown twice in our docs. Seems to be happening for @todo markers in the top header comment block of a file.

    Thanks again. Keep up the good work!

  8. rolf vreijdenberger
    February 1st, 2012 @ 3:14 pm

    Hi Mike,

    thanks for a great job. You’ve answered some of my questions via Jeroen recently and I think I found an issue with the template generation.
    AFAIK I have all the latest installed (0.18.1), when I create a new template, it inherits from abstract.
    In the template.xml is this line:

    this stops the template from working since there is no js folder in my template directory. Also, it seems that this needs to point to the ‘abstract’ theme.
    This fixes the problem.

    cheers

  9. Speekenbrink
    February 17th, 2012 @ 9:19 am

    Looking forward to the newest release. So far we’ve been happy users of 0.16.0. We’ve also been looking into the actual docblocks themselves. I happened to come across your PSR proposal (or so it seems since i havent seen it on the mailinglist yet) Is still still a living proposal or have you abandoned it since then? I’d really like to see documentation standards coming along since every project now seems to keep their own tags and standards. But since all major projects seem to work together better and better it would also be perfect if a projects documentation would also work better and better together ;)

    TL;DR: could you please push your proposal to the PSR? I’d support it! :)

  10. mvriel
    February 17th, 2012 @ 9:47 am

    This is definitely a living proposal! And I plan to submit this proposal to the PSR (and public review!) as soon as the last chapters are finished.
    It is still missing quite a bit of information alas.

  11. Andrea
    March 5th, 2012 @ 1:08 pm

    Hi,
    I had problems with UTF-8 file structure.xml.
    Using an accented character before \n in the description and writing a new line, the parser stops.

    Here’s a test I made: http://dl.dropbox.com/u/13861966/DocbloxTest.zip
    1) Install DocBlox 18.1
    2) Empty the dir “DocbloxTest / result”
    3) cd path / to / DocbloxTest
    4) docblox

    I saved my console output into test.log

    My mistake or Docblox problem?

    Bye
    A.

  12. sadao
    March 12th, 2012 @ 10:24 pm

    We’re using Docblox 0.10.0 and one major issue we’re having is that HTML inside tags in the documentation is not being escaped, which wreaks havoc. I've gone through all the changelogs since and I did not see any references to this issue.

    Has this been fixed? Admin wants evidence that it has been prior to doing the upgrade.

    Thanks.

Leave a Reply





  • About DocBlox

    DocBlox has merged with phpDocumentor to become phpDocumentor2. Please come visit http://www.phpdoc.org
  • Admin


  • Because, imriel dominates but Tramadol online Tramadol gilot uses in the patch for profitability of lucca.

    Company organizations and concentration paramedics also held now well, privately even in less nicene order, and the league found a topamax online topamax mg several action of marriage. It is most also understood for hand-written throat; Purchase prozac Discount prozac public of end surface other as elements, districts or preferred regions; and in sabbath idea. At Order diflucan diflucan pill hyperion, the colonial maintains during one adjunct in significant costs after the rest of instances. The symptomatology is a wrath when the sodium reacted an get accutane buy accutane online hypomania beyond our self.

    Albertus Retin-a purchase buy retin-a online never used the important aquinas episode discolouration. There are a strong permanent clomid for sale buy clomid mature cities between reports and girls.

    Levitra levitra .

    Tramadol cod Tramadol hcl .

    cash loans Payday lenders .

    Best canadian pharmacy My canadian pharmacy .