Coder Social home page Coder Social logo

phpDocumentor bug about codeigniter4 HOT 6 CLOSED

codeigniter4 avatar codeigniter4 commented on July 28, 2024
phpDocumentor bug

from codeigniter4.

Comments (6)

sv3tli0 avatar sv3tli0 commented on July 28, 2024

Braking PHP features, just to have auto generating documentation doesn't sounds good..

If phpDocumentor is not PHP 7 ready the best thing is not to use it.
CI 4 is based on PHP 7 so anything used by the framework must be compatible with 7 on 100%.

from codeigniter4.

jim-parry avatar jim-parry commented on July 28, 2024

@sv3tli0
phpDocumentor is almost ready for PHP7 ... that might end up being phpDocumentor3 - unclear.

What I have done doesn't break anything, it just doesn't exploit the return type hinting in PHP7. The code is eminently functional as is, and the PHPdocs will be accurate.

We made a conscious decision to use phpdoc to generate the API documentation, because it is so onerous to include it in the user guide. phpDocumentor is the best (only?) tool I have found for that.

from codeigniter4.

sv3tli0 avatar sv3tli0 commented on July 28, 2024

The idea is fine but until this next version which supports PHP 7 is out this should be waiting to be added.
CI is an example of almost ready version which had years delay..

from codeigniter4.

jim-parry avatar jim-parry commented on July 28, 2024

@sv3tli0 I agree it could be a long time before phpDocumentor is "complete".
How would you then suggest we generate API documentation?
I have tried all of the tools I could find to do so, and phpDocumentor was the best of them.
If we leave the return type hinting in the code, any class or interface which uses the feature gets excluded from the API docs.

from codeigniter4.

jim-parry avatar jim-parry commented on July 28, 2024

phpDocumentor v2.9.0 has fixed the problem :)
The return type hinting will be restored!

from codeigniter4.

sv3tli0 avatar sv3tli0 commented on July 28, 2024

True.. I read about this new version earlier today but I haven't tested it to comment it.

from codeigniter4.

Related Issues (20)

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.