-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
phpdoc.dist.xml
41 lines (36 loc) · 1.55 KB
/
phpdoc.dist.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
<!-- Title of your project. It will be used to show a mini description -->
<title>`phpdoc-vuepress` demo</title>
<!-- [1]
Directories and files from where will be extracted the documentation;
where your PHP sources are. -->
<files>
<!-- In this case, the soures to document are in the `demo/` dir-->
<directory>demo</directory>
<!-- You can include as many <directory> you need. And also, specific files
by using <file> tag-->
<!-- <file>vendor/cakephp/utility/Text.php</file> -->
</files>
<transformer>
<!-- [2]
Directory where the generate documentation files be. Set it according to
your VuePress config. In this case, it will be used the route `/demo`,
but you can use any you want -->
<target>docs/demo</target>
</transformer>
<transformations>
<!-- [3] Directory where the template.xml is. In this case, the template.xml file is in that directory -->
<template name="data/templates/vuepress" />
<!-- But in your Composer project, you should use the following line instead of the previous one. -->
<!-- <template name="vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress" /> -->
</transformations>
<parser>
<!-- [4] Elements to include in your documentation by visibility:
public, protected and private. -->
<visibility>public,protected</visibility>
<!-- Directory where to put the cache. This can be set to any directory.
Remember ignore it by Git -->
<target>build/api-cache</target>
</parser>
</phpdoc>