MadelineProto/build_docs.php
Daniil Gentili df24fa4611
Merge alpha into master (async, huge bugfixes and more) (#546)
* Implement async and lots of bugfixes

* Implement more async

* Implement async, implement bugfixes for the connection module, for the datacenter module, huge bugfixes, huge perfomance improvements, media DCs for https, advanced selecting, custom var_dump, totally rewritten IOLoop and response mechanism, promises, improvements to the TL parser, custom mb_substr

* Apply fixes from StyleCI

* Bugfixes

* Apply fixes from StyleCI

* Bugfixes, implement combined promises

* Apply fixes from StyleCI

* Support passing method arguments as callable

* Starting to write async upload logic

* Apply fixes from StyleCI

* Start implementing async file upload

* Apply fixes from StyleCI

* bugfix

* Apply fixes from StyleCI

* Start rewriting connection module

* Add PHP file docblocks for all classes

* Start working on new async stream API

* Finish writing stream API

* More stream API fixes

* Apply fixes from StyleCI

* Rewrite DataCenter and Connection modules

* Clean up stream API documentation

* Fixes

* Apply fixes from StyleCI

* Add referenced parameter to get length of buffer to read in getReadBuffer API

* Moved all MessageHandler code in the Connection module, added a PHP version warning in the phar

* Start fixing reads

* Fix all protocol stream wrappers

* Apply fixes from StyleCI

* Implement disconnection, and remove end function

* Working async RPC

* Implement async file upload

* Bugfix

* Method recall bugfixes

* Bugfixes

* Trait bugfixes

* Fix FIFO buffer

* Bugfixes and speedtests

* Async logging

* Implement websocket streams

* Implement loop API, signal API, clean closing and start changing layer

* Small magna, websocket and HTTP fixes

* Clean up loop API

* Improved stack traces, 2FA and async

* Login fixes

* Added instructions for manual verification

* Small fixes

* More app info improvements

* More app info improvements

* TL and 2FA fixes

* Update to layer 89

* More bugfixes

* Implement broken media reporting

* Remove debug comments

* PHP 7.2 backwards compatibility

* Bugfixes

* Async key generation

* Some simplifications

* Transport fixes

* Cleanup

* async API

* Performance fixes

* Fixes to async API

* Bugfixes

* Implement one-time async loop

* Authorization and logging fixes

* Update to layer 91

* 7to5 fix

* Null coalesce conversion

* Implement socks5 proxy

* Implement HTTP proxy

* Fixes to HTTP proxy

* MTProxy and socks5 fixes

* Disable PHP 5 conversion

* Proxies have higher priority

* Avoid error handling in vendor

* Override composer dependencies

* Fix travis build

* Final composer fixes

* Proxy logic fixes

* Fix get_updates update handling

* Do not use parallel file driver if not supported

* Refactor loader and implement HTTP fixes

* Suppress errors in loader

* HTTP and authorization fixes

* HTTP fixes

* Improved peer management

* Use HTTP protocol on altervista

* Small bugfixes

* Minor fixes

* Docufix

* Docufix

* Legacy fixes

* Fix message queue

* Avoid updating if using MTProxy

* Improve logs and examples

* Trim final newlines while converting parse mode

* Reimplement noResponse flag

* Async combined event handler and APIFactory fixes

* Actually return config

* Case-insensitive methods

* Bugfix

* Apply fixes from StyleCI (#545)

* MTProxy fixes

* PHP 5 warning

* Improved PHP 5 warning

* Use <br> along with newlines in web logs

* Update docs
2018-12-26 20:51:14 +01:00

83 lines
3.5 KiB
PHP
Executable File

#!/usr/bin/env php
<?php
/*
Copyright 2016-2018 Daniil Gentili
(https://daniil.it)
This file is part of MadelineProto.
MadelineProto is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
MadelineProto is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Affero General Public License for more details.
You should have received a copy of the GNU General Public License along with MadelineProto.
If not, see <http://www.gnu.org/licenses/>.
*/
require 'vendor/autoload.php';
$param = 1;
\danog\MadelineProto\Logger::constructor($param);
$logger = \danog\MadelineProto\Logger::$default;
set_error_handler(['\danog\MadelineProto\Exception', 'ExceptionErrorHandler']);
\danog\MadelineProto\Logger::log('Copying readme...', \danog\MadelineProto\Logger::NOTICE);
file_put_contents('docs/docs/index.md', '---
title: MadelineProto documentation
description: PHP client/server for the telegram MTProto protocol (a better tg-cli)
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
'.str_replace('<img', '<amp-img', file_get_contents('README.md')));
$docs = [
[
'tl_schema' => ['td' => __DIR__.'/src/danog/MadelineProto/TL_td.tl'],
'title' => 'MadelineProto API documentation (td-lib)',
'description' => 'MadelineProto API documentation (td-lib)',
'output_dir' => __DIR__.'/docs/docs/TD_docs',
'readme' => false,
'td' => true,
],
[
'tl_schema' => ['mtproto' => __DIR__.'/src/danog/MadelineProto/TL_mtproto_v1.json'],
'title' => 'MadelineProto API documentation (mtproto)',
'description' => 'MadelineProto API documentation (mtproto)',
'output_dir' => __DIR__.'/docs/docs/MTProto_docs',
'readme' => false,
],
[
'tl_schema' => ['telegram' => __DIR__.'/src/danog/MadelineProto/TL_telegram_v91.tl', 'calls' => __DIR__.'/src/danog/MadelineProto/TL_calls.tl', 'secret' => __DIR__.'/src/danog/MadelineProto/TL_secret.tl', 'td' => __DIR__.'/src/danog/MadelineProto/TL_td.tl'],
'title' => 'MadelineProto API documentation (layer 91)',
'description' => 'MadelineProto API documentation (layer 91)',
'output_dir' => __DIR__.'/docs/docs/API_docs',
'readme' => false,
],
];
$layer_list = '';
foreach (array_slice(glob(__DIR__.'/src/danog/MadelineProto/TL_telegram_*'), 0, -1) as $file) {
$layer = preg_replace(['/.*telegram_/', '/\..+/'], '', $file);
$docs[] = [
'tl_schema' => ['telegram' => $file],
'title' => 'MadelineProto API documentation (layer '.$layer.')',
'description' => 'MadelineProto API documentation (layer '.$layer.')',
'output_dir' => __DIR__.'/docs/old_docs/API_docs_'.$layer,
'readme' => true,
];
$layer_list = '[Layer '.$layer.'](API_docs_'.$layer.'/)
';
}
file_put_contents('docs/old_docs/README.md', '---
title: Documentations of old mtproto layers
description: Documentation of old mtproto layers
---
# Documentation of old mtproto layers
'.$layer_list);
$doc = new \danog\MadelineProto\AnnotationsBuilder($logger, $docs[2]);
$doc->mk_annotations();
foreach ($docs as $settings) {
$doc = new \danog\MadelineProto\DocsBuilder($logger, $settings);
$doc->mk_docs();
}