search

theseer / phpdox

Documentation generator for PHP Code using standard technology (SRC, DOCBLOCK, XML and XSLT)
http://phpdox.de
Other
600 stars 121 forks source link

PHPcs enricher - information in list #346

Open peldax opened 5 years ago

peldax commented 5 years ago

Hi, first of all, thank you for this project. I might help with the development once I squeeze some budget for it, because it works flawlessly. I like the idea with enrichment, where I push static analysis data into generated documentation.

What I miss is simply number of violations for a class in list of classes, or some general overview of violations with quick access, so I just just quickly look around which file is in a bad shape without getting to its detail.

Thank you. :+1:

theseer commented 5 years ago

Thanks for the idea!

Unfortunately, phpDox currently suffers a lot under a lack of time, so development goes a lot slower than I'd wish. Having a view like you describe is on my list of things for quite a while already but so far I didn't have the time to implement it.

phpDox needs quite some internal cleanup as development moved into directions that make some design choices questionable and some things just turned out suboptimal ;)

But thanks for the pointer!

peldax commented 5 years ago

@theseer Thanks for the reply, if you give me some quick pointers about internal architecture I might improve phpDox myself. I am also missing feature about loading multiple different checkstyle files - many analysers can export to checkstyle so there is no need to add specialised enricher for them, named checkstyle will do.

theseer commented 5 years ago

To give a quick heads up: phpdox-0.12.0-dev is the moving tag for PHP 7.1+ with updated dependencies. I'm trying to fix some more outstanding things and then finally new features can be added.