[wp-trac] Re: [WordPress Trac] #5638: PHPdoc effort for formatting.php

[WordPress Trac]

#5638: PHPdoc effort for formatting.php
------------------------------+---------------------------------------------
 Reporter:  darkdragon        |        Owner:  anonymous
     Type:  enhancement       |       Status:  new      
 Priority:  low               |    Milestone:  2.7      
Component:  Optimization      |      Version:           
 Severity:  trivial           |   Resolution:           
 Keywords:  phpdoc has-patch  |  
------------------------------+---------------------------------------------
Comment (by santosj):

 @schoust

 The convention has changed to where the short description doesn't have the
 "{{{function_name() - }}}" text. The reason for the change was that it
 doesn't make sense in PHPXref and PHPdocumentor sites as well as some
 editors. The reason I didn't remove all of them was I have had many
 conflicts in the past with the file and it helps to know which function
 the inline documentation goes to when conflicts do occur.

 I advise that you remove them when you are finished with the inline
 documentation for a function to keep track of the ones that still need
 inline documentation. I'm submitting patches that removes them from other
 files.

-- 
Ticket URL: <http://trac.wordpress.org/ticket/5638#comment:11>
WordPress Trac <http://trac.wordpress.org/>
WordPress blogging software