Skip to content

mostlynick3/Eluna-ALE-PHP-Docs

Repository files navigation

Eluna / ALE API Docs

A plug-and-play, self-hosted PHP documentation browser for Eluna and ALE — parses your .h method headers directly, no build step required.


Features

  • Plug-and-play — point it at your headers directory and it works
  • Inheritance tree — subclasses show inherited methods with source attribution
  • Live search — instant search across all classes and methods
  • Auto-parsed docs@param, @return, @proto, enum blocks, and inline links all rendered automatically
  • Easily customizable — single CSS file, straightforward PHP partials

Screenshots

Full site

Full site

Inheritance — inherited methods shown in subclasses

Inheritance

Search

Search

Setup

  1. Clone the repo into your web server's document root.
  2. Edit config.php and set headers_dir to your Eluna/ALE methods directory. You can, for example, git clone mod-ale directly into this dir to have it work right out of the box.
  3. Done.

Optionally, you may also fork this repository and set up GitHub Pages to make static HTML copies of the docs for your personal Eluna/ALE version, by editing the sources array in generate_github_docs.php.


Roadmap

  • File-based caching. Parse once, serve statically instead of re-parsing on every request.
  • Hashing/target dir size check to re-cache on methods dir changes. GitHub Pages pull from sources every 24 hours, and users can optionally set up re-fetching of local source files.

About

PHP docs parser for Eluna/ALE

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors