Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Save functions order in phpdoc

Tags:

php

phpdoc

I'm running phpdoc on my project and there's a file (the only meaningful file), in which the order of methods is important for grouping methods. How can I have the same order of functions in the generated documentation as in the source file?

Actually, I'm ready to change doc framework, if it helps.

like image 590
Dmitry Ginzburg Avatar asked Jun 19 '15 09:06

Dmitry Ginzburg


1 Answers

Unfortunately, it doesn't appear there is a way to tell the documenter what order to list methods in.

However, @see may be useful to you to draw attention to the related functions. That coupled with a note in the full description about the order being needed, or some out of order exceptions may be the best the tool can currently offer.

like image 146
ToothlessRebel Avatar answered Sep 18 '22 22:09

ToothlessRebel