composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-12 23:14:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

📝 Fix /doc readme (thanks @jbostoen !)

Browse Source
This commit is contained in:
Pierre Goiffon
2019-05-23 18:25:26 +02:00
parent 17d4b570e8
commit ec086ad94a
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.doc/README.md
View File

@@ -12,11 +12,11 @@ some tags where added :
* `@phpdoc-tunning-exclude-inherited`: tunning tag that inform this template to ignere inherited methods in the rendrering.
some behaviours where added :
* only public `@api` and `@api-advanced` are showed
* only public `@api` and `@api-advanced` are shown
* class properties are hidden (subject to change, but will require to white list them using `@api` tag)
known limitations:
* inline tag do not work properly
* inline tags do not work properly
* links are hardcoded instead of using phpdoc routes (adding our own routes was too complex)
* `@see` tags must be very specific:
* always prefix class members with `Class::` (ie: `DBObject::Get()`)
@@ -32,9 +32,9 @@ known limitations:
## dokuwiki requirements
* the templates uses the [wrap plugin](https://www.dokuwiki.org/plugin:wrap).
* the template uses the [wrap plugin](https://www.dokuwiki.org/plugin:wrap).
* the generated files have to be placed under an arbitrary directory of `[/path/to/dokuwiki]/data/pages`.
* the html as to be activated [config:htmlok](https://www.dokuwiki.org/config:htmlok)
* the html has to be activated [config:htmlok](https://www.dokuwiki.org/config:htmlok)
* the generated files have to be in lowercase
## installation