This commit is contained in:
Daniil Gentili 2018-04-04 20:14:59 +02:00
commit 044f3ab63d
5 changed files with 30 additions and 5 deletions

View File

@ -19,7 +19,8 @@ set_error_handler(['\danog\MadelineProto\Exception', 'ExceptionErrorHandler']);
file_put_contents('docs/docs/index.md', '--- file_put_contents('docs/docs/index.md', '---
title: MadelineProto documentation title: MadelineProto documentation
description: PHP implementation of telegram\'s MTProto protocol 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'))); '.str_replace('<img', '<amp-img', file_get_contents('README.md')));

2
docs

@ -1 +1 @@
Subproject commit 4f9438b1c1b270d36a89862c398f932230d4b6a5 Subproject commit 916411226dd921657305ee7c344c870f6800f479

View File

@ -57,6 +57,7 @@ class DocsBuilder
file_put_contents($this->index, '--- file_put_contents($this->index, '---
title: '.$this->settings['title'].' title: '.$this->settings['title'].'
description: '.$this->settings['description'].' description: '.$this->settings['description'].'
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
# '.$this->settings['description'].' # '.$this->settings['description'].'
@ -109,8 +110,9 @@ description: '.$this->settings['description'].'
$header = '--- $header = '---
title: '.$type.' title: '.$type.'
description: constructors and methods of type '.$type.' description: constructors and methods of type '.$type.'
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: '.str_replace('_', '\\_', $type).' # Type: '.str_replace('_', '\\_', $type).'
[Back to types index](index.md) [Back to types index](index.md)
@ -418,6 +420,7 @@ After modifying it, you must always parse the new configuration with a call to `
file_put_contents('types/'.$this->index, '--- file_put_contents('types/'.$this->index, '---
title: Types title: Types
description: List of types description: List of types
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
# Types # Types
[Back to API documentation index](..) [Back to API documentation index](..)
@ -428,6 +431,7 @@ description: List of types
file_put_contents('types/string.md', '--- file_put_contents('types/string.md', '---
title: string title: string
description: A UTF8 string of variable length description: A UTF8 string of variable length
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: string ## Type: string
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -437,6 +441,7 @@ A UTF8 string of variable length. The total length in bytes of the string must n
file_put_contents('types/bytes.md', '--- file_put_contents('types/bytes.md', '---
title: bytes title: bytes
description: A string of variable length description: A string of variable length
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: bytes ## Type: bytes
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -446,6 +451,7 @@ A string of bytes of variable length, with length smaller than or equal to 16777
file_put_contents('types/int.md', '--- file_put_contents('types/int.md', '---
title: integer title: integer
description: A 32 bit signed integer ranging from -2147483648 to 2147483647 description: A 32 bit signed integer ranging from -2147483648 to 2147483647
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: int ## Type: int
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -455,6 +461,7 @@ A 32 bit signed integer ranging from `-2147483648` to `2147483647`.
file_put_contents('types/int53.md', '--- file_put_contents('types/int53.md', '---
title: integer title: integer
description: A 53 bit signed integer description: A 53 bit signed integer
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: int53 ## Type: int53
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -464,6 +471,7 @@ A 53 bit signed integer.
file_put_contents('types/long.md', '--- file_put_contents('types/long.md', '---
title: long title: long
description: A 32 bit signed integer ranging from -9223372036854775808 to 9223372036854775807 description: A 32 bit signed integer ranging from -9223372036854775808 to 9223372036854775807
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: long ## Type: long
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -473,6 +481,7 @@ A 64 bit signed integer ranging from `-9223372036854775808` to `9223372036854775
file_put_contents('types/int128.md', '--- file_put_contents('types/int128.md', '---
title: int128 title: int128
description: A 128 bit signed integer description: A 128 bit signed integer
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: int128 ## Type: int128
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -482,6 +491,7 @@ A 128 bit signed integer represented in little-endian base256 (`string`) format.
file_put_contents('types/int256.md', '--- file_put_contents('types/int256.md', '---
title: int256 title: int256
description: A 256 bit signed integer description: A 256 bit signed integer
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: int256 ## Type: int256
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -491,6 +501,7 @@ A 256 bit signed integer represented in little-endian base256 (`string`) format.
file_put_contents('types/int512.md', '--- file_put_contents('types/int512.md', '---
title: int512 title: int512
description: A 512 bit signed integer description: A 512 bit signed integer
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: int512 ## Type: int512
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -500,6 +511,7 @@ A 512 bit signed integer represented in little-endian base256 (`string`) format.
file_put_contents('types/double.md', '--- file_put_contents('types/double.md', '---
title: double title: double
description: A double precision floating point number description: A double precision floating point number
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: double ## Type: double
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -509,6 +521,7 @@ A double precision floating point number, single precision can also be used (flo
file_put_contents('types/!X.md', '--- file_put_contents('types/!X.md', '---
title: !X title: !X
description: Represents a TL serialized payload description: Represents a TL serialized payload
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: !X ## Type: !X
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -518,6 +531,7 @@ Represents a TL serialized payload.
file_put_contents('types/X.md', '--- file_put_contents('types/X.md', '---
title: X title: X
description: Represents a TL serialized payload description: Represents a TL serialized payload
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: X ## Type: X
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -527,6 +541,7 @@ Represents a TL serialized payload.
file_put_contents('constructors/boolFalse.md', '--- file_put_contents('constructors/boolFalse.md', '---
title: boolFalse title: boolFalse
description: Represents a boolean with value equal to false description: Represents a boolean with value equal to false
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
# boolFalse # boolFalse
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -536,6 +551,7 @@ description: Represents a boolean with value equal to false
file_put_contents('constructors/boolTrue.md', '--- file_put_contents('constructors/boolTrue.md', '---
title: boolTrue title: boolTrue
description: Represents a boolean with value equal to true description: Represents a boolean with value equal to true
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
# boolTrue # boolTrue
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -545,6 +561,7 @@ Represents a boolean with value equal to `true`.
file_put_contents('constructors/null.md', '--- file_put_contents('constructors/null.md', '---
title: null title: null
description: Represents a null value description: Represents a null value
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
# null # null
[Back to constructor index](index.md) [Back to constructor index](index.md)
@ -554,6 +571,7 @@ Represents a `null` value.
file_put_contents('types/Bool.md', '--- file_put_contents('types/Bool.md', '---
title: Bool title: Bool
description: Represents a boolean. description: Represents a boolean.
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
# Bool # Bool
[Back to types index](index.md) [Back to types index](index.md)
@ -563,6 +581,7 @@ Represents a boolean.
file_put_contents('types/DataJSON.md', '--- file_put_contents('types/DataJSON.md', '---
title: DataJSON title: DataJSON
description: Any json-encodable data description: Any json-encodable data
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Type: DataJSON ## Type: DataJSON
[Back to constructor index](index.md) [Back to constructor index](index.md)

View File

@ -178,8 +178,9 @@ trait Constructors
$header = '--- $header = '---
title: '.$data['predicate'].' title: '.$data['predicate'].'
description: '.$description.' description: '.$description.'
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Constructor: '.str_replace('_', '\\_', $data['predicate'].$layer).' # Constructor: '.str_replace('_', '\\_', $data['predicate'].$layer).'
[Back to constructors index](index.md) [Back to constructors index](index.md)
@ -280,6 +281,7 @@ MadelineProto supports all html entities supported by [html_entity_decode](http:
file_put_contents('constructors/'.$this->index, '--- file_put_contents('constructors/'.$this->index, '---
title: Constructors title: Constructors
description: List of constructors description: List of constructors
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
# Constructors # Constructors
[Back to API documentation index](..) [Back to API documentation index](..)

View File

@ -171,8 +171,9 @@ trait Methods
$header = '--- $header = '---
title: '.$data['method'].' title: '.$data['method'].'
description: '.$description.' description: '.$description.'
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
## Method: '.str_replace('_', '\\_', $data['method']).' # Method: '.str_replace('_', '\\_', $data['method']).'
[Back to methods index](index.md) [Back to methods index](index.md)
@ -324,6 +325,7 @@ MadelineProto supports all html entities supported by [html_entity_decode](http:
file_put_contents('methods/api_'.$this->index, '--- file_put_contents('methods/api_'.$this->index, '---
title: Methods title: Methods
description: List of methods description: List of methods
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
# Methods # Methods
[Back to API documentation index](..) [Back to API documentation index](..)
@ -361,6 +363,7 @@ $MadelineProto->[request_secret_chat](https://docs.madelineproto.xyz/request_sec
file_put_contents('methods/'.$this->index, '--- file_put_contents('methods/'.$this->index, '---
title: Methods title: Methods
description: What do you want to do? description: What do you want to do?
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
--- ---
# What do you want to do? # What do you want to do?
[Go back to API documentation index](..) [Go back to API documentation index](..)