added comments in news.c and nntp.c
authorHoà Viêt Dinh <dinh.viet.hoa@free.fr>
Tue, 24 Apr 2001 13:53:43 +0000 (13:53 +0000)
committerHoà Viêt Dinh <dinh.viet.hoa@free.fr>
Tue, 24 Apr 2001 13:53:43 +0000 (13:53 +0000)
src/news.c
src/nntp.c

index e1b0254..de69fb9 100644 (file)
@@ -484,6 +484,15 @@ static void news_delete_all_article(FolderItem *item)
        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;
@@ -547,6 +556,10 @@ GSList * news_get_group_list(FolderItem *item)
        return group_list;
 }
 
+/*
+  remove the cache file of the names of the newsgroups.
+ */
+
 void news_reset_group_list(FolderItem *item)
 {
        gchar *path, *filename;
index 0c7ed6e..7082078 100644 (file)
@@ -260,6 +260,11 @@ static gint nntp_gen_recv(gint sock, gchar *buf, gint size)
        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;