Comments (6)
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.
@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.
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.
@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.
phpDocumentor v2.9.0 has fixed the problem :)
The return type hinting will be restored!
from codeigniter4.
True.. I read about this new version earlier today but I haven't tested it to comment it.
from codeigniter4.
Related Issues (20)
- Bug: form_open with no URL supplied HOT 2
- Bug: `service('example')` null return if service is defined in the custom namespace in Manual Installation CI4.5.0 HOT 2
- Official User Guide is not updated HOT 1
- Bug: [Postgre] Unable to connect to the database HOT 5
- Bug: Failed to open stream: No such file or directory (root/index.php) HOT 4
- Bug: [QueryBuilder] join() with BETWEEN causes TypeError preg_quote(): Argument #1 ($str) must be of type string, false given HOT 7
- Bug: redirect()->back() caching issue HOT 2
- Bug: getInsertID is only returning 0 when using the Save() method HOT 3
- Bug: CI4 + Shield + Postgre Spark error HOT 3
- Bug: bootstrap on `preload` not updated to last v4.5.1 HOT 1
- Bug: [ErrorException] Undefined array key "opcache.enable" HOT 1
- Bug: [Model] when the query ($this->first()) result returns NULL we get TypeError HOT 2
- Bug: [Model] BaseBuilder::limit(): Argument #1 ($value) must be of type ?int, string given HOT 3
- Bug: Invalid date format for ORACLE database for created_at and updated_at HOT 2
- Bug: Entity::$dataCaster must not be accessed before initialization HOT 1
- How to add CI4 in a raw project and use the database class? HOT 2
- Bug: calling force_https() in 404 controller causes error HOT 8
- The lang function exposes the name of your language file if there is no record. HOT 1
- Bug: Error when run php spark cmd in testing env HOT 2
- Bug(SQLite3): Forge::dropColumn() seems to always return false HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from codeigniter4.