added comments in news.c and nntp.c

diff --git a/src/news.c b/src/news.c
index e1b025410f64352755b6d6880e5d87375b1109f4..de69fb915ef48e26ae2802bc70ed9dc1e9ff44f6 100644 (file)
--- a/src/news.c
+++ b/src/news.c
@@ -484,6 +484,15 @@ static void news_delete_all_article(FolderItem *item)
        debug_print(_("done.\n"));
 }
 
        debug_print(_("done.\n"));
 }
 

+/*
+  news_get_group_list returns a strings list.
+  These strings are the names of the newsgroups of a server.
+  item is the FolderItem of the news server.
+  The names of the newsgroups are cached into a file so that
+  when the function is called again, there is no need to make
+  a request to the server.
+ */
+

 GSList * news_get_group_list(FolderItem *item)
 {
        gchar *path, *filename;
 GSList * news_get_group_list(FolderItem *item)
 {
        gchar *path, *filename;


@@ -547,6 +556,10 @@ GSList * news_get_group_list(FolderItem *item)
        return group_list;
 }
 
        return group_list;
 }
 

+/*
+  remove the cache file of the names of the newsgroups.
+ */
+

 void news_reset_group_list(FolderItem *item)
 {
        gchar *path, *filename;
 void news_reset_group_list(FolderItem *item)
 {
        gchar *path, *filename;

diff --git a/src/nntp.c b/src/nntp.c
index 0c7ed6e2ca30a028f0df6bda97a4bd4aa70480cc..708207830498cab3d566ca5151e646a0d83d7e56 100644 (file)
--- a/src/nntp.c
+++ b/src/nntp.c
@@ -260,6 +260,11 @@ static gint nntp_gen_recv(gint sock, gchar *buf, gint size)
        return NN_SUCCESS;
 }
 
        return NN_SUCCESS;
 }
 

+/*
+  nntp_list sends the command "LIST" to the news server,
+  a function is needed to read the newsgroups list.
+ */
+

 gint nntp_list(gint sock)
 {
        GList * result = NULL;
 gint nntp_list(gint sock)
 {
        GList * result = NULL;