Move comments with description of python file to top of files

diff --git a/src/qweechat/about.py b/src/qweechat/about.py
index 74c0beb9dd209f15355e02208c05834bd3e010af..80023b405258b936fe942104e3cacd294a322811 100644 (file)
--- a/src/qweechat/about.py
+++ b/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')

diff --git a/src/qweechat/buffer.py b/src/qweechat/buffer.py
index 0c09e919ce64c33fd09bce8075d93a47f1a898bb..704abce166c437a3532cd306c2e6f780c778eabd 100644 (file)
--- a/src/qweechat/buffer.py
+++ b/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')

diff --git a/src/qweechat/chat.py b/src/qweechat/chat.py
index 3e91bc48ba8aafd6172852e7ae60c8cfecf355c6..4ed7d97e6eb092ec01a73d9835b535afec7de84f 100644 (file)
--- a/src/qweechat/chat.py
+++ b/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')

diff --git a/src/qweechat/config.py b/src/qweechat/config.py
index 8e4d4560fdcc8ee96a2441694372138fc709a72d..efcaff71b3db3c507081b37fa53c03fe75e55aab 100644 (file)
--- a/src/qweechat/config.py
+++ b/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
 

diff --git a/src/qweechat/connection.py b/src/qweechat/connection.py
index 0ceff69918b1efab1dc5d3a7f30fdc1a8b895823..0f19cb50b60beb8caa0bf22ba3d7e9b7310cf9ae 100644 (file)
--- a/src/qweechat/connection.py
+++ b/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')
 

diff --git a/src/qweechat/debug.py b/src/qweechat/debug.py
index 0b844e8d8077b6e66e6ab8e4957bcc0f085f104e..e14cdab6a8eb0766ac4d3f01a794c85f9b704a29 100644 (file)
--- a/src/qweechat/debug.py
+++ b/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

diff --git a/src/qweechat/input.py b/src/qweechat/input.py
index ee3b2e62640f150004cabb1f5fa5ef64fbae0b50..42c3f8e4822841c9b26339ec99af38cafd4391fe 100644 (file)
--- a/src/qweechat/input.py
+++ b/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')

diff --git a/src/qweechat/network.py b/src/qweechat/network.py
index af3ab1c7d15fc46383e504e6648d9d635f9b2ecc..9b4922245a4bed9ddc6a8ccb40bf33299e356fab 100644 (file)
--- a/src/qweechat/network.py
+++ b/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')

diff --git a/src/qweechat/qweechat.py b/src/qweechat/qweechat.py
index 55bd70b3dd21b30d4a78ba48e0e3dc2c1c9f56c7..61d7fcf08fd4419f39a6ef360bf0f09920dbfae2 100755 (executable)
--- a/src/qweechat/qweechat.py
+++ b/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:
 #

diff --git a/src/qweechat/weechat/color.py b/src/qweechat/weechat/color.py
index 63472e9680bfe943d570b06a01853e8d2a5cb2b9..09195a0ea049ae926f262acfd042c9a85238be36 100644 (file)
--- a/src/qweechat/weechat/color.py
+++ b/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'[*!/_|]*'

diff --git a/src/qweechat/weechat/protocol.py b/src/qweechat/weechat/protocol.py
index 056eac45e92677bff4c95b3c4f39d797b0df7394..b0a4fb11ca7a79af05c99913f1b07975acfdaf19 100644 (file)
--- a/src/qweechat/weechat/protocol.py
+++ b/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:
 #