Giter VIP home page Giter VIP logo

Comments (2)

mike42 avatar mike42 commented on August 26, 2024

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.

from doxyphp2sphinx.

hxtree avatar hxtree commented on August 26, 2024

+1 happening here https://github.com/ouxsoft/LivingMarkup . Will have to comment out the EXCLUDE_SYMBOLS to see.

from doxyphp2sphinx.

Related Issues (3)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.