From 9b784d23b08e379c36dabe76fc2645a99817dee0 Mon Sep 17 00:00:00 2001 From: Marcus Bointon Date: Sun, 1 May 2016 17:30:19 +0200 Subject: [PATCH] Simplify phpdocs generation --- .gitignore | 4 ++-- docs/README.md | 2 +- docs/generatedocs.sh | 8 -------- phpdoc.dist.xml | 20 ++++++++++++++++++++ src/PHPMailer.php | 3 +-- 5 files changed, 24 insertions(+), 13 deletions(-) delete mode 100755 docs/generatedocs.sh create mode 100644 phpdoc.dist.xml diff --git a/.gitignore b/.gitignore index c2d968f2..42cda674 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ -docs/phpdoc/ +docs/ +!docs/README.md test/message.txt test/testbootstrap.php *.pem -.idea build/ vendor/ diff --git a/docs/README.md b/docs/README.md index 25f11ac1..b8f8f734 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # PHPMailer Documentation -Pre-built PHPMailer API documentation is not provided with the PHP classes, but you can generate API documentation by running the `generatedocs.sh` shell script in this folder. You will need to have [phpDocumentor](https://www.phpdoc.org) installed. This documentation is also [available online](http://phpmailer.github.io/PHPMailer/), though it may not be quite up to date or match your version. +Pre-built PHPMailer API documentation is not provided with the PHP classes, but you can generate API documentation by running `phpdoc` in the top-level folder of this project, and documentation will be generated in this folder. You will need to have [phpDocumentor](https://www.phpdoc.org) installed. This documentation is also [available online](http://phpmailer.github.io/PHPMailer/), though it may not be quite up to date or match your version exactly. The configuration for phpdoc is in the [phpdoc.dist.xml file](https://github.com/PHPMailer/PHPMailer/blob/master/phpdoc.dist.xml). Further help and information is available in [the PHPMailer README](https://github.com/PHPMailer/PHPMailer/blob/master/README.md), [the examples folder](https://github.com/PHPMailer/PHPMailer/tree/master/examples), and in [the GitHub wiki](https://github.com/PHPMailer/PHPMailer/wiki). diff --git a/docs/generatedocs.sh b/docs/generatedocs.sh deleted file mode 100755 index c9bf2162..00000000 --- a/docs/generatedocs.sh +++ /dev/null @@ -1,8 +0,0 @@ -#!/bin/sh -# Regenerate PHPMailer documentation -# Run from within the docs folder -rm -rf phpdoc/* -phpdoc --directory ../src --target ./phpdoc --sourcecode --force --title PHPMailer --template="clean" -# You can merge regenerated docs into a separate docs working copy without messing up the git status like so: -# rsync -a --delete --exclude ".git" --exclude "phpdoc-cache-*/" --exclude "README.md" phpdoc/ ../../phpmailer-docs -# After updating docs, push/PR them to the phpmailer gh-pages branch: https://github.com/PHPMailer/PHPMailer/tree/gh-pages diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml new file mode 100644 index 00000000..a9d582a3 --- /dev/null +++ b/phpdoc.dist.xml @@ -0,0 +1,20 @@ + + + PHPMailer + + docs + utf8 + + TODO + + + + docs + + +