Open brotkrueml opened 4 years ago
I was able to replicate this locally by cloning your repo, then generating XML documention for it with Doxygen.
This is definitely a bug. It is tripping up on this method in RestClient.php
:
/**
* Creates a RestClient instance, already authenticated against the JobRouter system
*
* @param ClientConfiguration $configuration The configuration
*
* @throws AuthenticationException
* @throws HttpException
*/
public function __construct(ClientConfiguration $configuration)
{
$this->configuration = $configuration;
$this->psr17factory = new Psr17Factory();
$client = new Curl($this->psr17factory);
$this->browser = new Browser($client, $this->psr17factory);
$this->browser->addMiddleware(new UserAgentMiddleware($this->configuration->getUserAgentAddition()));
$this->authorisationMiddleware = new AuthorisationMiddleware();
$this->browser->addMiddleware($this->authorisationMiddleware);
$this->authenticate();
}
The parameter list appears like this in the XML:
<parameterlist kind="param">
<parameteritem>
<parameternamelist>
<parametertype>ClientConfiguration</parametertype>
<parametername>$configuration</parametername>
</parameternamelist>
<parameterdescription>
<para>The configuration</para>
</parameterdescription>
</parameteritem>
</parameterlist>
<parameterlist kind="exception">
<parameteritem>
<parameternamelist>
<parametername>AuthenticationException</parametername>
</parameternamelist>
<parameterdescription>
<para/>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>HttpException</parametername>
</parameternamelist>
<parameterdescription>
<para/>
</parameterdescription>
</parameteritem>
</parameterlist>
However this code does not distinguish between the exception
and param
lists, and assumes (incorrectly) that they will contain the same fields.
I could work around this issue with a small code change, but it then fails in other places instead. More investigation is required.
+1 happening here https://github.com/ouxsoft/LivingMarkup . Will have to comment out the EXCLUDE_SYMBOLS to see.
When calling doxyphp2sphinx I got this stack trace on a class:
class: github.com/brotkrueml/jobrouter-client/blob/master/src/Client/RestClient.php
XML: pastebin.com/AGY6J7pF