Skip to content

A VS Code extension that read workspace PHP files and builds a wiki from the PHPDocs within them

Notifications You must be signed in to change notification settings

finleyaa/phpdocwiki

Repository files navigation

PHPDoc Wiki README

PHPDoc Wiki reads your PHPDoc comments and generates a wiki-style tree view. It is designed to help you easily search and navigate your PHPDoc comments, making it easier to understand and maintain your code.

Features

  • Generate Wiki Page: Automatically generates a wiki-style documentation page from your PHPDoc comments when opening a workspace.
  • Search and Navigation: Using the PHPDoc Wiki: Search command, you can search for classes using a fuzzy search of all PHPDocs within the class and it's methods.

Extension Settings

This extension contributes the following settings:

  • phpdocwiki.includePaths: An array of paths to include in the wiki generation. This can be set to specific directories.
  • phpdocwiki.excludePaths: An array of paths to exclude from the wiki generation. This can be set to specific directories.

Release Notes

1.0.0

Initial release of PHPDoc Wiki.

About

A VS Code extension that read workspace PHP files and builds a wiki from the PHPDocs within them

Resources

Stars

Watchers

Forks