Move comments with description of python file to top of files

src/qweechat/about.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
+# about.py - about dialog box
+#
 # Copyright (C) 2011-2013 Sebastien Helleu <flashcode@flashtux.org>
 #
 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
@@ -19,10 +21,6 @@
 # along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# About dialog box.
-#
-
 import qt_compat
 QtCore = qt_compat.import_module('QtCore')
 QtGui = qt_compat.import_module('QtGui')

src/qweechat/buffer.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
+# buffer.py - management of WeeChat buffers/nicklist
+#
 # Copyright (C) 2011-2013 Sebastien Helleu <flashcode@flashtux.org>
 #
 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
@@ -19,10 +21,6 @@
 # along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# Buffers.
-#
-
 import qt_compat
 QtCore = qt_compat.import_module('QtCore')
 QtGui = qt_compat.import_module('QtGui')

src/qweechat/chat.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
+# chat.py - chat area
+#
 # Copyright (C) 2011-2013 Sebastien Helleu <flashcode@flashtux.org>
 #
 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
@@ -19,10 +21,6 @@
 # along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# Chat area.
-#
-
 import datetime
 import qt_compat
 QtCore = qt_compat.import_module('QtCore')

src/qweechat/config.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
+# config.py - configuration for QWeeChat (~/.qweechat/qweechat.conf)
+#
 # Copyright (C) 2011-2013 Sebastien Helleu <flashcode@flashtux.org>
 #
 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
@@ -19,10 +21,6 @@
 # along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# Configuration for QWeeChat (~/.qweechat/qweechat.conf)
-#
-
 import os, ConfigParser
 import weechat.color as color
 

src/qweechat/connection.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
+# connection.py - connection window
+#
 # Copyright (C) 2011-2013 Sebastien Helleu <flashcode@flashtux.org>
 #
 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
@@ -19,10 +21,6 @@
 # along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# Connection window.
-#
-
 import qt_compat
 QtGui = qt_compat.import_module('QtGui')
 

src/qweechat/debug.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
+# debug.py - debug window
+#
 # Copyright (C) 2011-2013 Sebastien Helleu <flashcode@flashtux.org>
 #
 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
@@ -19,10 +21,6 @@
 # along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# Debug window.
-#
-
 import qt_compat
 QtGui = qt_compat.import_module('QtGui')
 from chat import ChatTextEdit

src/qweechat/input.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
+# input.py - input line for chat and debug window
+#
 # Copyright (C) 2011-2013 Sebastien Helleu <flashcode@flashtux.org>
 #
 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
@@ -19,10 +21,6 @@
 # along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# Input line (for chat or debug window).
-#
-
 import qt_compat
 QtCore = qt_compat.import_module('QtCore')
 QtGui = qt_compat.import_module('QtGui')

src/qweechat/network.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
+# network.py - I/O with WeeChat/relay
+#
 # Copyright (C) 2011-2013 Sebastien Helleu <flashcode@flashtux.org>
 #
 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
@@ -19,10 +21,6 @@
 # along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# I/O with WeeChat/relay.
-#
-
 import struct
 import qt_compat
 QtCore = qt_compat.import_module('QtCore')

src/qweechat/qweechat.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
+# qweechat.py - WeeChat remote GUI using Qt toolkit
+#
 # Copyright (C) 2011-2013 Sebastien Helleu <flashcode@flashtux.org>
 #
 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
@@ -20,8 +22,7 @@
 #
 
 #
-# QWeeChat - WeeChat remote GUI using Qt toolkit.
+# This script requires WeeChat 0.3.7 or newer, running on local or remote host.
-# (this script requires WeeChat 0.3.7 or newer, running on local or remote host)
 #
 # History:
 #

src/qweechat/weechat/color.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
+# color.py - remove/replace colors in WeeChat strings
+#
 # Copyright (C) 2011-2013 Sebastien Helleu <flashcode@flashtux.org>
 #
 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
@@ -19,10 +21,6 @@
 # along with QWeeChat.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-#
-# Remove or replace colors in WeeChat strings.
-#
-
 import re
 
 RE_COLOR_ATTRS = r'[*!/_|]*'

src/qweechat/weechat/protocol.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 #
+# protocol.py - decode binary messages received from WeeChat/relay
+#
 # Copyright (C) 2011-2013 Sebastien Helleu <flashcode@flashtux.org>
 #
 # This file is part of QWeeChat, a Qt remote GUI for WeeChat.
@@ -20,10 +22,8 @@
 #
 
 #
-# Decode binary messages received from WeeChat/relay.
+# For info about protocol and format of messages, please read document
-#
+# "WeeChat Relay Protocol", available at:  http://www.weechat.org/doc/
-# For info about protocol and format of messages, please read document "WeeChat Relay Protocol",
-# available at:  http://www.weechat.org/doc/
 #
 # History:
 #