Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #1258 from virtualtam/refactor/phpdoc

Browse source 
Replace Doxygen with phpDocumentor to generate reference documentation
This commit is contained in:
Aurélien Tamisier 2019-01-23 22:14:32 +01:00 committed by GitHub
commit e664865e2e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 26 additions and 2382 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.gitignore vendored
View file

@ -22,15 +22,16 @@ inc/languages/*/LC_MESSAGES/shaarli.mo
# Development and test resources # Development and test resources
coverage coverage
doxygen
sandbox sandbox
phpmd.html phpmd.html
phpdoc.xml
# User plugin configuration # User plugin configuration
plugins/*/config.php plugins/*/config.php
# HTML documentation # HTML documentation
doc/html/ doc/html/
doc/phpdoc/
# 3rd party themes # 3rd party themes
tpl/* tpl/*

2377
Doxyfile
View file

File diff suppressed because it is too large Load diff

7
Makefile
View file

@ -146,10 +146,9 @@ authors:
@git shortlog -sne > AUTHORS @git shortlog -sne > AUTHORS
@rm .mailmap @rm .mailmap
### generate Doxygen documentation ### generate phpDocumentor documentation
doxygen: clean phpdoc: clean
@rm -rf doxygen @docker run --rm -v $(PWD):/data -u `id -u`:`id -g` phpdoc/phpdoc
@doxygen Doxyfile
### generate HTML documentation from Markdown pages with MkDocs ### generate HTML documentation from Markdown pages with MkDocs
htmldoc: htmldoc:

21
phpdoc.dist.xml Normal file
View file

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
<title><![CDATA[Shaarli API Reference]]></title>
<parser>
<encoding>utf8</encoding>
<markers>
<item>FIXME</item>
<item>TODO</item>
<item>WIP</item>
</markers>
<target>doc/phpdoc</target>
</parser>
<transformer>
<target>doc/phpdoc</target>
</transformer>
<files>
<file>index.php</file>
<directory>application</directory>
<directory>plugins</directory>
</files>
</phpdoc>