[Phpmyadmin-devel] Writing useful docblocks

Hi all, especially GSoC students just a quick reminder, that docblocks are meant to document function and it's parameters, so writing docblocks as following is quite useless: /** * * @param type $srid * @param type $scale_data * @param type $output */ - You should describe what the function is supposed to do - You should document actual types of parameters instead of writing there "type" - You should document parameter meaning Thank you for your cooperation in making readable and easy to understand code. -- Michal Čihař | http://cihar.com | http://blog.cihar.com