Simplify phpdocs generation
This commit is contained in:
parent
da739aa763
commit
9b784d23b0
|
|
@ -1,7 +1,7 @@
|
||||||
docs/phpdoc/
|
docs/
|
||||||
|
!docs/README.md
|
||||||
test/message.txt
|
test/message.txt
|
||||||
test/testbootstrap.php
|
test/testbootstrap.php
|
||||||
*.pem
|
*.pem
|
||||||
.idea
|
|
||||||
build/
|
build/
|
||||||
vendor/
|
vendor/
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# PHPMailer Documentation
|
# 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).
|
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).
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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
|
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8" ?>
|
||||||
|
<phpdoc>
|
||||||
|
<title>PHPMailer</title>
|
||||||
|
<parser>
|
||||||
|
<target>docs</target>
|
||||||
|
<encoding>utf8</encoding>
|
||||||
|
<markers>
|
||||||
|
<item>TODO</item>
|
||||||
|
</markers>
|
||||||
|
</parser>
|
||||||
|
<transformer>
|
||||||
|
<target>docs</target>
|
||||||
|
</transformer>
|
||||||
|
<transformations>
|
||||||
|
<template name="clean"/>
|
||||||
|
</transformations>
|
||||||
|
<files>
|
||||||
|
<directory>src</directory>
|
||||||
|
</files>
|
||||||
|
</phpdoc>
|
||||||
|
|
@ -3800,8 +3800,7 @@ class PHPMailer
|
||||||
protected function doCallback($isSent, $to, $cc, $bcc, $subject, $body, $from)
|
protected function doCallback($isSent, $to, $cc, $bcc, $subject, $body, $from)
|
||||||
{
|
{
|
||||||
if (!empty($this->action_function) and is_callable($this->action_function)) {
|
if (!empty($this->action_function) and is_callable($this->action_function)) {
|
||||||
$params = [$isSent, $to, $cc, $bcc, $subject, $body, $from];
|
call_user_func_array($this->action_function, [$isSent, $to, $cc, $bcc, $subject, $body, $from]);
|
||||||
call_user_func_array($this->action_function, $params);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue