WordPress / WordPress/phpdoc-parser

Add support for parsing docs for single constants

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

Nobody has claimed this yet.

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

Description

The parser already technically supports parsing constants, but the attached PR hooks them up to a new post type and retrieves the associated documentation. We can add post type / editing / display support at a later time in the wporg-developer theme, but it would be nice to be actually storing the descriptions somewhere.

PR: #203

It should be noted that parsing DocBlock template support is not yet available in phpDocumentor, which means core WordPress is kind of out of luck with the current state of constants documented in wp-config.php. Templates are the ability to document multiple elements at the same time, e.g.

/**#@+
 * DocBlock Template example: One summary for all.
 *
 * One description for all.
 *
 * @since 2.6.0
 */
define('AUTH_KEY',         '...');
define('SECURE_AUTH_KEY',  '...');
define('LOGGED_IN_KEY',    '...');
define('NONCE_KEY',        '...');
define('AUTH_SALT',        '...');
define('SECURE_AUTH_SALT', '...');
define('LOGGED_IN_SALT',   '...');
define('NONCE_SALT',       '...');

/**#@-*/

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

Start with PR #203 and the parser's existing constant-handling path. Check how the PR hooks constants into a post type and retrieves their documentation; done means descriptions are stored, while post type editing and display support remain out of scope. Note that phpDocumentor does not yet support DocBlock templates.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.