Skip to content

Commit ce2474e

Browse files
committed
Add some texts to the docs
1 parent 459d951 commit ce2474e

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

docs/class_alof.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,7 @@ Alof
88

99
Alof is the class that contains the functions of AlofLib.
1010

11-
.. php:class:: Alof
12-
Alof contains all the ALO functions.
13-
14-
.. php:method:: is_alo($value)
15-
Returns whether the given value is an ALO.
16-
:param mixed $value: The value to check.
17-
:returns: Whether the value is an ALO.
11+
Its full qualification is Vectorial1024\AlofLib\Alof.
1812

13+
FOr now, please refer to the PHP source code for the documentation. We are finding a way to automatically generate compatible documentations from PHP sources.
1914

docs/index.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,14 @@
66
Welcome to alof-lib's documentation!
77
====================================
88

9+
AlofLib is a PHP library to provide some util functions to array-like objects:
10+
- Implements Traversable
11+
- Implements ArrayAccess
12+
13+
While PHPDoc doc-blocks contain the latest documentation about the library,
14+
there was an unsuccessful attempt to produce ReadTheDocs documentation.
15+
If you know how to build ReadTheDoc documentation from PHPDoc doc-blocks, then you are most welcome to make a PR!
16+
917
.. toctree::
1018
:maxdepth: 2
1119
:caption: Contents:

0 commit comments

Comments
 (0)