Finalize comments

plugins/display/all_visits.py

@@ -4,6 +4,31 @@ from iwla import IWLA
 from iplugin import IPlugin
 from display import *
 
+#
+# Display hook
+# 
+# Create All visits page
+#
+# Plugin requirements :
+#     None
+#
+# Conf values needed :
+#     display_visitor_ip*
+#
+# Output files :
+#     OUTPUT_ROOT/year/month/all_visits.html
+#     OUTPUT_ROOT/year/month/index.html
+#
+# Statistics creation :
+#     None
+#
+# Statistics update :
+#     None
+#
+# Statistics deletion :
+#     None
+#
+
 class IWLADisplayAllVisits(IPlugin):
     def __init__(self, iwla):
         super(IWLADisplayAllVisits, self).__init__(iwla)

plugins/display/referers.py

@@ -4,6 +4,32 @@ from iwla import IWLA
 from iplugin import IPlugin
 from display import *
 
+#
+# Display hook
+# 
+# Create Referers page
+#
+# Plugin requirements :
+#     post_analysis/referers
+#
+# Conf values needed :
+#     None
+#
+# Output files :
+#     OUTPUT_ROOT/year/month/referers.html
+#     OUTPUT_ROOT/year/month/key_phrases.html
+#     OUTPUT_ROOT/year/month/index.html
+#
+# Statistics creation :
+#     None
+#
+# Statistics update :
+#     None
+#
+# Statistics deletion :
+#     None
+#
+
 class IWLADisplayReferers(IPlugin):
     def __init__(self, iwla):
         super(IWLADisplayReferers, self).__init__(iwla)

plugins/display/top_downloads.py

@@ -4,6 +4,31 @@ from iwla import IWLA
 from iplugin import IPlugin
 from display import *
 
+#
+# Display hook
+# 
+# Create TOP downloads page
+#
+# Plugin requirements :
+#     post_analysis/top_downloads
+#
+# Conf values needed :
+#     None
+#
+# Output files :
+#     OUTPUT_ROOT/year/month/top_downloads.html
+#     OUTPUT_ROOT/year/month/index.html
+#
+# Statistics creation :
+#     None
+#
+# Statistics update :
+#     None
+#
+# Statistics deletion :
+#     None
+#
+
 class IWLADisplayTopDownloads(IPlugin):
     def __init__(self, iwla):
         super(IWLADisplayTopDownloads, self).__init__(iwla)

plugins/display/top_hits.py

@@ -4,6 +4,31 @@ from iwla import IWLA
 from iplugin import IPlugin
 from display import *
 
+#
+# Display hook
+# 
+# Create TOP hits page
+#
+# Plugin requirements :
+#     post_analysis/top_hits
+#
+# Conf values needed :
+#     None
+#
+# Output files :
+#     OUTPUT_ROOT/year/month/top_hits.html
+#     OUTPUT_ROOT/year/month/index.html
+#
+# Statistics creation :
+#     None
+#
+# Statistics update :
+#     None
+#
+# Statistics deletion :
+#     None
+#
+
 class IWLADisplayTopHits(IPlugin):
     def __init__(self, iwla):
         super(IWLADisplayTopHits, self).__init__(iwla)

plugins/display/top_pages.py

@@ -4,6 +4,31 @@ from iwla import IWLA
 from iplugin import IPlugin
 from display import *
 
+#
+# Display hook
+# 
+# Create TOP pages page
+#
+# Plugin requirements :
+#     post_analysis/top_pages
+#
+# Conf values needed :
+#     None
+#
+# Output files :
+#     OUTPUT_ROOT/year/month/top_pages.html
+#     OUTPUT_ROOT/year/month/index.html
+#
+# Statistics creation :
+#     None
+#
+# Statistics update :
+#     None
+#
+# Statistics deletion :
+#     None
+#
+
 class IWLADisplayTopPages(IPlugin):
     def __init__(self, iwla):
         super(IWLADisplayTopPages, self).__init__(iwla)

plugins/display/top_visitors.py

@@ -4,6 +4,29 @@ from iwla import IWLA
 from iplugin import IPlugin
 from display import *
 
+#
+# Display hook
+# 
+# Create TOP visitors block
+#
+# Plugin requirements :
+#     None
+#
+# Conf values needed :
+#     display_visitor_ip*
+#
+# Output files :
+#     OUTPUT_ROOT/year/month/index.html
+#
+# Statistics creation :
+#     None
+#
+# Statistics update :
+#     None
+#
+# Statistics deletion :
+#     None
+#
 class IWLADisplayTopVisitors(IPlugin):
     def __init__(self, iwla):
         super(IWLADisplayTopVisitors, self).__init__(iwla)

plugins/post_analysis/top_hits.py

@@ -10,7 +10,7 @@ from iplugin import IPlugin
 #     None
 #
 # Conf values needed :
-#     reverse_dns_timeout*
+#     None
 #
 # Output files :
 #     None

plugins/post_analysis/top_pages.py

@@ -3,6 +3,32 @@ import re
 from iwla import IWLA
 from iplugin import IPlugin
 
+#
+# Post analysis hook
+# 
+# Count TOP pages
+#
+# Plugin requirements :
+#     None
+#
+# Conf values needed :
+#     None
+#
+# Output files :
+#     None
+#
+# Statistics creation :
+#     None
+#
+# Statistics update :
+# month_stats:
+#    top_pages =>
+#        uri
+#
+# Statistics deletion :
+#     None
+#
+
 class IWLAPostAnalysisTopPages(IPlugin):
     def __init__(self, iwla):
         super(IWLAPostAnalysisTopPages, self).__init__(iwla)