You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,14 @@
4
4
5
5
We all document our code with PHP [DocBlocks](https://en.wikipedia.org/wiki/PHPDoc) but we never seem to actually generate the documentation and add it to our project. Why? It simply takes too much time (over a minute), so we put it off till later, and later never comes.
6
6
7
-
But with PHPFUI\InstaDoc, you can document your site in about a minute (OK, maybe 2). The steps involved:
8
-
* Install PHPFUI\InstaDoc via Composer (30 seconds)
7
+
But with PHPFUI/InstaDoc, you can document your site in about a minute (OK, maybe 2). The steps involved:
8
+
* Install PHPFUI/InstaDoc via Composer (30 seconds)
9
9
* Run installation script (30 seconds)
10
10
* Create document page (1 minute, 6 lines of code)
11
11
12
12
Two minutes to usable documentation with the following features:
13
13
14
-
## PHPFUI\InstaDoc Features
14
+
## PHPFUI/InstaDoc Features
15
15
* Always up to date, even with code that is not yet checked in
16
16
* Send constructor information including parameters and default values to clipboard
17
17
* Child and Parent class hierarchy clearly displayed and accessable
@@ -28,7 +28,7 @@ But with PHPFUI\InstaDoc, you can document your site in about a minute (OK, mayb
28
28
* 5+ line config compatible with all PHP frameworks, or standalone
29
29
* Uses [Foundation CSS framework](https://get.foundation) for a great experience on mobile
Example: **php vendor/phpfui/instadoc/install.php public/PHPFUI** will add all needed files to public/PHPFUI, which will avoid any conflicts with your current files. You can specify any directory by using \PHPFUI\Page::setResourcePath, but PHPFUI is recomended to keep things simple.
41
41
42
42
### Create Document Page
43
-
PHPFUI\InstaDoc does not reply on any framework and can run on a standalone page. It is recommended that you do not make your documentation public, as PHPFUI\InstaDoc will display PHP source files. How you restrict access to the page is up to you. The following does not restrict access and is simply an example:
43
+
PHPFUI/InstaDoc does not reply on any framework and can run on a standalone page. It is recommended that you do not make your documentation public, as PHPFUI/InstaDoc will display PHP source files. How you restrict access to the page is up to you. The following does not restrict access and is simply an example:
44
44
45
45
```php
46
46
<?php
@@ -67,7 +67,7 @@ echo $controller->display();
67
67
That is it. You are done!
68
68
69
69
### Adding New Classes
70
-
PHPFUI\InstaDoc saves the classes to display in PHP serialized files. Delete those files (.serial extension) when you want to display new classes. PHPFUI\InstaDoc will regenerate automatically if the files are missing.
70
+
PHPFUI/InstaDoc saves the classes to display in PHP serialized files. Delete those files (.serial extension) when you want to display new classes. PHPFUI/InstaDoc will regenerate automatically if the files are missing.
0 commit comments