1
wishcraft
Incrediable amount of phpDocumentor errors - Over 40 pages

If you check this (http://feeds.labs.coop/docs/) completely clean code for documented with standard tags included no added on to changing the config of phpDocumentor 2.0 which is part of Unit Testing.

See on the report of the health of the project documentation reasons; where you need to fix a clean work flow of:

@package class
@subpackage xoopscache

You also need at least one @summary take with every element and node of the code; you can have several @summary which is the summary depiction and perhaps examples of the function in a line of @summary

You need to include with at least class header the @author if not in every piece of the function declarations as well. You can have multiple @author.

If you look at the xoops phpDocumentor on http://xoops2.6.labs.coop/ and the report you will find 40 pages of errors on http://xoops2.6.labs.coop/reports/errors.html

We need also the @version and @params and even additional tags which would have to be the result of hours of redoing comments in XOOPS 2.6 Alpha can be made up cause you can tell phpDocumentor what comment tags it should focus on, so if you can think of a useful @tag to add or two maybe three do it.

I think we should have a @category for example.

This document at http://xoops2.6.labs.coop/reports/errors.html was created by running at the command line:

phpdoc -. -t docs


This builds an API Document PHP Document. This or an earlier version is what http://www.php.net was based on!

Resized Image
http://www.ohloh.net/accounts/226400

Follow, Like & Read:-

twitter.com/RegaltyFamily
github.com/Chronolabs-Cooperative
facebook.com/DrAntonyRoberts

2
wishcraft
Re: Incrediable amount of phpDocumentor errors - Over 40 pages

This sort of docs folder is inclusive in the archive docs Normally in pro-releases of code!

I don't know why mamba said I was spaming the facebook page, I was using it within facebook terms cause I had 5 posts in a row but when I checked a week later after not being able to post or leave the group from my favorites, mamba had done 12 posts in a row in total over zealous posting and basically network spam!
Resized Image
http://www.ohloh.net/accounts/226400

Follow, Like & Read:-

twitter.com/RegaltyFamily
github.com/Chronolabs-Cooperative
facebook.com/DrAntonyRoberts

3
redheadedrod
Re: Incrediable amount of phpDocumentor errors - Over 40 pages

Simon, we are going with PSR2 coding which also includes some information about php documentation. It really doesn't matter what phpdoc gives out as errors as long as the code passes PSR2. At the current time xoops does not pass PSR2. Xoops 2.6 will move in the direction of PSR2 but may not be fully compatible with it by the time the final version is available. There is much that needs to be done to the core to make it pass PSR2.

I would guess if PHPDoc will allow PSR2 compatible coding that may be an option down the road. At this time there is much that needs to be done with 2.6 before it gets released as a beta.

Not to mention the added libraries that don't pass PSR2 tests at this time and won't in the final product either since they are added without modification.

Rodney

Attending College working towards Bachelors in Software Engineering and Network Security.

Login

Who's Online

410 user(s) are online (312 user(s) are browsing Support Forums)


Members: 0


Guests: 410


more...

Donat-O-Meter

Stats
Goal: $100.00
Due Date: Nov 30
Gross Amount: $0.00
Net Balance: $0.00
Left to go: $100.00
Make donations with PayPal!

Latest GitHub Commits