[Phpmyadmin-devel] On the @uses comment tag

[Tyron Madlener]

On Mon, Jun 20, 2011 at 11:59 AM, Michal Čihař <michal at cihar.com> wrote:
> Hi
>
> Dne Sun, 19 Jun 2011 23:30:53 +0200
> Piotr Przybylski <piotr.prz at gmail.com> napsal(a):
>
>> How the @uses tag should be used? I am randomly fixing some comments
>> and would like to know what to do with them. I see it used to denote
>> used global variables, internal PHP functions and phpMyAdmin
>> functions. This should be cleaned up, at least by removing all
>> mentions of internal PHP functions.
>
> Honestly I see no use for @uses, so I'd suggest to drop it completely
> as it anyway tends not to be updated with the code.
>

Since they are all in the same format and unique we could just run a
regexp over all pma php files that removes those lines.
Something like this (untested):

replace('.');
function replace($dir) {
  $rdir = opendir($dir);
  while($file=readdir($rdir)) {
   if(is_dir($dir.'/'.$file) && $file!='.' && $file!='..')
replace($dir.'/'.$file);
   else {
    $text = file_get_contents($file);
    $fp = fopen($file,'w');
    fwrite($fp, preg_replace("/^\s*\*\s*@uses.*/m",'',$text));
    fclose($fp);
  }
}

> --
>        Michal Čihař | http://cihar.com | http://blog.cihar.com
>
> ------------------------------------------------------------------------------
> EditLive Enterprise is the world's most technically advanced content
> authoring tool. Experience the power of Track Changes, Inline Image
> Editing and ensure content is compliant with Accessibility Checking.
> http://p.sf.net/sfu/ephox-dev2dev
> _______________________________________________
> Phpmyadmin-devel mailing list
> Phpmyadmin-devel at lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/phpmyadmin-devel
>
>