You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/08/29 15:29:48 UTC

svn commit: r1378541 - /lucene/dev/trunk/dev-tools/scripts/checkJavaDocs.py

Author: rmuir
Date: Wed Aug 29 13:29:48 2012
New Revision: 1378541

URL: http://svn.apache.org/viewvc?rev=1378541&view=rev
Log:
LUCENE-4324: enable broken html detection

Modified:
    lucene/dev/trunk/dev-tools/scripts/checkJavaDocs.py

Modified: lucene/dev/trunk/dev-tools/scripts/checkJavaDocs.py
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/dev-tools/scripts/checkJavaDocs.py?rev=1378541&r1=1378540&r2=1378541&view=diff
==============================================================================
--- lucene/dev/trunk/dev-tools/scripts/checkJavaDocs.py (original)
+++ lucene/dev/trunk/dev-tools/scripts/checkJavaDocs.py Wed Aug 29 13:29:48 2012
@@ -134,6 +134,9 @@ def checkClassDetails(fullPath):
     print(fullPath)
     for cat, item, message in errors:
       print('  broken details HTML: %s: %s: %s' % (cat, item, message))
+    return True
+  else:
+    return False
 
 def checkClassSummaries(fullPath):
 
@@ -328,14 +331,15 @@ def checkPackageSummaries(root, level='c
     if 'package-summary.html' in fileNames:
       if level != 'package' and checkSummary('%s/package-summary.html' % dirPath):
         anyMissing = True
-      if level == 'method': 
-        for fileName in fileNames:
-          fullPath = '%s/%s' % (dirPath, fileName)
-          if not fileName.startswith('package-') and fileName.endswith('.html') and os.path.isfile(fullPath):
+      for fileName in fileNames:
+        fullPath = '%s/%s' % (dirPath, fileName)
+        if not fileName.startswith('package-') and fileName.endswith('.html') and os.path.isfile(fullPath):
+          if level == 'method':
             if checkClassSummaries(fullPath):
               anyMissing = True
-            if checkClassDetails(fullPath):
-              anyMissing = True
+          # always look for broken html, regardless of level supplied
+          if checkClassDetails(fullPath):
+            anyMissing = True
               
     if 'overview-summary.html' in fileNames:        
       if checkSummary('%s/overview-summary.html' % dirPath):