PLATFORM
  • Tails

    Create websites with TailwindCSS

  • Blocks

    Design blocks for your website

  • Wave

    Start building the next great SAAS

  • Pines

    Alpine & Tailwind UI Library

  • Auth

    Plug'n Play Authentication for Laravel

  • Designer comingsoon

    Create website designs with AI

  • DevBlog comingsoon

    Blog platform for developers

  • Static

    Build a simple static website

  • SaaS Adventure

    21-day program to build a SAAS

Question By
Unsolved

phpDocumentator Junk Output

ookma-kyi

Mar 30th, 2024 08:38 AM

Hello,

I am trying to set up PHPStorm 2023.3.6 to use phpDocumentator 3.7.3, and I am having issues. For starters, there is no phpDocumentor plugin to make this easier. Second when I run phpDocumentator I get junk output. I have it setup to run as an external tool:

Program: php
Parameters: C:/Laragon/bin/phpdocumentator/phpdocumentator.phar --config="$ProjectFileDir$/phpdoc.dist.xml"
Working directory: C:/Laragon/bin/phpdocumentator/

Here is my phpdoc.dist.xml:

<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
    <title>${PROJECT_NAME}</title>
    <parser>
        <target>phpdocs/output</target>
        <extensions>
            <extension>module</extension>
            <extension>inc</extension>
            <extension>php</extension>
        </extensions>
    </parser>
    <transformer>
        <target>phpdocs/docs</target>
    </transformer>
    <files>
        <ignore>tests/*</ignore>
        <ignore>Tests/*</ignore>
    </files>
</phpdoc>
bobbyiliev

Mar 31st, 2024 03:30 AM

Hello Ookma-Kyi,

The "Deprecated" warnings that you've shared in the output, suggest that phpDocumentor is using some outdated PHP features that are no longer recommended in newer PHP versions.

As far as I can see the latest stable phpDocumentor latest version is v3.4.3:

And it requires PHP 8.1 or higher to run.

I don't see 3.7.3 available out there, can you confirm that you are indeed using that version?

Also, as the v3.4.3 requires PHP 8.1 or higher to run, can you confirm the PHP version that you are using?

If you are running v3.4.3 and PHP 8.1 or higher and you are still getting that deprecation warning, the best thing that you could do is to report that as an issue on the official repository:

https://github.com/phpDocumentor/phpDocumentor/issues

The maintainers would be able to advise you further.