File src/class/Ext/Scrawl.php

class Lia\Ext\Scrawl

Generates documentation listing:

  • Packages
  • Addons
  • Routes
  • Views
  • Configurable Options (and maybe listing configs that have been set)
    See source code at /src/class/Ext/Scrawl.php

Constants

Properties

  • static public array $config_file_locations = [ 'config/liaison.json', '.config/liaison.json', 'config/lia.json', '.config/lia.json' ];

Methods

  • protected function generate_documentation(\Lia $lia, string $out_dir, string $base_dir) Actually generate the documentation and write it to the docs dir.

  • public function get_callable_details($c, $base_dir)

  • public function get_rel_class_file(object $obj, string $base_dir): string

  • public function get_rel_path(string $abs_path, string $base_dir): string

  • static public function get_config_file(string $base_dir): string Get absolute path to liaison config file, or null if it does not exist.

  • public function bootstrap()

  • public function scan_filelist_processed(array $code_files, array $all_exports) Called when all files are finished being processed

  • protected function get_lia_instance(string $base_dir, array $configs): \Lia