Skip to content

mostlynick3/Eluna-ALE-PHP-Docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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
return [
    'headers_dir' => __DIR__ . '/mod-ale/src/LuaEngine/methods',
    'site_title'  => 'Eluna / ALE API',
];

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

About

PHP docs parser for Eluna/ALE

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors