Update documentation

Add config file for Doxygen
This commit is contained in:
PJ Dietz 2013-01-27 14:14:45 -05:00
parent 22db41c0e5
commit 871f76f008
5 changed files with 1914 additions and 6 deletions

3
.gitignore vendored
View File

@ -1,6 +1,9 @@
# Composer # Composer
vendor/ vendor/
# Doxygen
docs/html
# PhpStorm # PhpStorm
workspace.xml workspace.xml

1902
docs/Doxyfile Normal file

File diff suppressed because it is too large Load Diff

View File

@ -5,6 +5,7 @@ namespace pjdietz\WellRESTed\Exceptions;
/** /**
* Exception related to a cURL operation. The message and code should correspond * Exception related to a cURL operation. The message and code should correspond
* to the cURL error and error number that caused the excpetion. * to the cURL error and error number that caused the excpetion.
*
*/ */
class CurlException extends WellrestedException {} class CurlException extends WellrestedException
{
}

View File

@ -2,9 +2,11 @@
namespace pjdietz\WellRESTed\Exceptions; namespace pjdietz\WellRESTed\Exceptions;
use \Exception;
/** /**
* Top level class for custom exceptions thrown by Well RESTed. * Top level class for custom exceptions thrown by Well RESTed.
*/ */
class WellrestedException extends \Exception {} class WellrestedException extends Exception
{
?> }

View File

@ -149,7 +149,7 @@ abstract class Message
/** /**
* Add or update a header to a given value * Add or update a header to a given value
* *
* @param string name * @param string $name
* @param $value * @param $value
* @param string $value * @param string $value
*/ */