WordPress / WordPress/phpdoc-parser

Substantial amounts of files unprocessed

Open
#235 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
239
Forks
81
Avg merge
16h 29m
Merged PRs (30d)
8

Description

I am running into issues with the PHPDOC Parser freshly installed today from SVN whereas several files simply are not processed.

Example, the JSON export (same when I create instead of export), remains as such:

{
        "file": {
            "description": "",
            "long_description": "",
            "tags": []
        },
        "path": "wp-includes\/post.php",
        "root": "\/Users\/username\/DEV\/MAMP\/wp-vanilla\/wordpress"
    },
    {

Or,

{
        "file": {
            "description": "",
            "long_description": "",
            "tags": []
        },
        "path": "wp-includes\/kses.php",
        "root": "\/Users\/username\/DEV\/MAMP\/wp-vanilla\/wordpress"
    },

This is on a Mac with latest WP, Parser, PHP8
It does not matter if I export or create

Basically, good two thirds of the files are not processed.
Most of the functions (register_post_type, for example) are therefore just never documented.

What can be the issue?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue using the export and create commands against the listed WordPress files, especially wp-includes/post.php and wp-includes/kses.php, on PHP 8. Then trace why these files produce empty descriptions, long descriptions, and tags; done means the missing files and functions, including register_post_type, are processed and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.