It is very hard for me to work with phpDocumentor 2.
I have several procedural-style files that need to be documented. The only thing I found is to use docblocks at the page level , but it seems that they do not work correctly in phpDocumentor 2 version.
Stack overflow.site/questions/978181 / ... shows that others are working on the same issue. There are two suggestions in this question:
- Add
namespace
to files that need to be documented - By phpDoc issue 910 use the
abstract
or new-black
template
Unfortunately, I canโt get a job either.
- When I add a namespace, the namespace itself appears in the document, but not the contents of the dock.
- When I select another template (I tried
zend
, abstract
and new-black
) with the phar version of phpDoc 2, I get the PHP Warning: XSLTProcessor::transformToUri(): No stylesheet associated to this object in phar
. This is apparently a known issue .
EDIT:
I have one more step. I installed the PEAR version of phpDocumentor and tried out every available template. But I'm still far from achieving the goal: page-level dockblocks in the generated documentation.
Templates are divided into two categories:
clean
, responsive
, responsive-twig
and old-ocean
: they do not output page-level documentation in the generated documentation.abstract
, new-black
and zend
: they have a doc section on files, which shows the expected documentation at the file level. But they skip several ressources (.js files and images), so they look the same and do not work correctly (the navigation bar has no extension-crash behavior). I looked into their git repository and the files seem to be skipped even there.
At this moment, I am just wondering if I am looking in the right direction: it seems incomprehensible that it is impossible to have documentation showing file level docblocks, due to serious regressions and errors in phpDocumentor 2.
If I'm really wrong, please suggest me get some valuable documentation from my PHP project. If I'm on the right track, please help me understand what an important role I have in the puzzle.
source share