objc file detection comments

Author: DellaBitta

scripts/format_code.py

@@ -130,7 +130,6 @@ def list_files_from_directory(path, recurse):
     in FILE_TYPE_EXTENSIONS.
   """
   filenames = []
-  
   for root, dirs, files in os.walk(path):
     for filename in files:
       if filename.endswith(FILE_TYPE_EXTENSIONS):
@@ -177,12 +176,19 @@ def validate_arguments():
       return False
   return True
 
-def is_file_objc(filename):
-  # Only detect header files since we already filter out other
-  # file types by extensions.
+def is_file_objc_header(filename):
+  """Checks the contents of the file to determine if it contains language 
+  constructs that appear in obj-c but not in C/C++.
+  
+  Args:
+    filename (string): the name of the file to check
+  
+  Returns:
+    bool: True if the header file contains known obj-c language definitions.
+    Returns False otherwise.
+  """
   if '.h' not in filename:
     return False
-
   objective_c_tags = [ '@end', '@class', '#import']
   for line in open(filename):
     for tag in objective_c_tags:
@@ -216,17 +222,17 @@ def main(argv):
     count = 0
     for filename in filenames:
         if does_file_need_formatting(filename):
-          if is_file_objc(filename):
+          if is_file_objc_header(filename):
             if FLAGS.verbose:
               print('  - Ignoring obj header: "{0}"'.format(filename)) 
           else:
             if FLAGS.verbose:
-              print('  - Formatting: "{0}"'.format(filename))
+              print('  - FRMT: "{0}"'.format(filename))
             format_file(filename)
             count += 1
         else:
           if FLAGS.verbose:
-            print('  - OK: "{0}"'.format(filename))
+            print('  - OK:   "{0}"'.format(filename))
     print('  > Formatted {0} file(s).'.format(count))
   else:
     count = 0