[wp-trac] [WordPress Trac] #14726: PHPDoc @license Tag Review

[WordPress Trac]

#14726: PHPDoc @license Tag Review
--------------------------+-------------------------------------------------
 Reporter:  hakre         |       Owner:                 
     Type:  defect (bug)  |      Status:  new            
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  General       |     Version:  3.0.1          
 Severity:  normal        |    Keywords:  has-patch      
--------------------------+-------------------------------------------------

Comment(by jacobsantos):

 Replying to [comment:3 hakre]:
 > Replying to [comment:2 jacobsantos]:
 > > Second patch looks good except for a few issues:
 > >
 > >  * Added subpackage to PemFTP files, and I suppose to fix the Pure
 class and the Socket class from not showing up in nightlies. The fix for
 this is simple without adding subpackage and should be fixed in a new
 ticket.
 >
 > I don't understand what that means, but if it's easy to fix, good :)

 Well, I was looking at [http://phpdoc.wordpress.org/trunk/ WordPress
 phpdoc] web site and the Pure and the Socket classes weren't showing up.
 The files were, so I'm guessing that the classes do not have class level
 phpdoc which is why they aren't showing up. This should be a in a new
 ticket to fix that.

 I actually have no plans to fix it though, I was simply pointing out that
 it doesn't belong in this ticket and that the fix is relatively simple to
 do, if not time consuming, but I guess a simple line or two putting the
 class in the right place would be easy enough.

 >
 > >  * The patch is dirty in some places making changes not related to the
 {{{@license}}} phpdoc tag. Some examples include the UTF8 translation to
 ANSI function.
 >
 > Do you mean character encoding in {{{/wp-includes/class-snoopy.php}}} /
 {{{_striptext()}}} line 720 and something?


 About the character encoding. I'm not sure. I realize that the encoding of
 the file tends to mess special characters up, but they shouldn't be
 included in the patch. As it would mess up the file when the patch is
 applied.

 If you are using tortoisesvn, then you could just view changes and then
 revert the changed characters. I'm not sure what will happen if the
 encoding hasn't changed. You might have to fix that on your end with a new
 check out or simply copying the file over checking out the file(s) with
 the correct encoding.

-- 
Ticket URL: <http://core.trac.wordpress.org/ticket/14726#comment:4>
WordPress Trac <http://core.trac.wordpress.org/>
WordPress blogging software